Eclipse PDE
Release 3.8

org.eclipse.pde.core.target
Interface ITargetLocationFactory


public interface ITargetLocationFactory

A factory to instantiate target locations from a serialized string of xml (see ITargetLocation.serialize()). A factory must be provided for each ITargetLocation type using the org.eclipse.pde.core.targetLocations extension point.

Since:
3.8

Method Summary
 ITargetLocation getTargetLocation(String type, String serializedXML)
          Returns an instance of an ITargetLocation from the provided serialized xml string or throws a CoreException if unable to do so.
 

Method Detail

getTargetLocation

ITargetLocation getTargetLocation(String type,
                                  String serializedXML)
                                  throws CoreException
Returns an instance of an ITargetLocation from the provided serialized xml string or throws a CoreException if unable to do so.

The serialized xml will not be prefixed by a XML declaration such as <?xml version="1.0" encoding="UTF-8"?>. The xml will contain a single root element named location with the attribute type that matches the type parameter. The root element may have children and other attributes set.

Parameters:
type - the string type describing the implementation of ITargetLocation expected, see ITargetLocation.getType()
serializedXML - the xml string describing the location to create, see ITargetLocation.serialize()
Returns:
an instance of ITargetLocation
Throws:
CoreException - if this factory cannot create a location for the specified type or if the xml string is invalid

Eclipse PDE
Release 3.8

Guidelines for using Eclipse APIs.

Copyright (c) 2000, 2013 IBM Corporation and others. All rights reserved.