Package org.eclipse.tycho.targetplatform

Class TargetDefinitionFile

java.lang.Object

org.eclipse.tycho.targetplatform.TargetDefinitionFile

All Implemented Interfaces:

TargetDefinition

public final class TargetDefinitionFile
extends Object
implements TargetDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.tycho.targetplatform.TargetDefinition

TargetDefinition.BNDInstructions, TargetDefinition.DirectoryLocation, TargetDefinition.FeaturesLocation, TargetDefinition.FollowRepositoryReferences, TargetDefinition.ImplicitDependency, TargetDefinition.IncludeMode, TargetDefinition.InstallableUnitLocation, TargetDefinition.Location, TargetDefinition.MavenDependency, TargetDefinition.MavenGAVLocation, TargetDefinition.PathLocation, TargetDefinition.ProfileLocation, TargetDefinition.RepositoryLocation, TargetDefinition.TargetReferenceLocation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_TARGET
static final String	ELEMENT_LOCATIONS
static final String	FILE_EXTENSION

Method Summary

Modifier and Type	Method	Description
List<? extends TargetDefinition.Location>	getLocations()
String	getOrigin()	Returns the origin of the target definition, e.g. a file path.
String	getTargetEE()	Returns the value of the targetJRE in *.target file if it's a known EE name.
boolean	hasIncludedBundles()	Returns true if the target definition specifies an explicit list of bundles to include (i.e. an <includeBundles> in target definition files).
Stream<TargetDefinition.ImplicitDependency>	implicitDependencies()
static boolean	isTargetFile(File file)
static File[]	listTargetFiles(File folder)	List all target files in the given folder
static TargetDefinitionFile	parse(Document document, String origin)
static Document	parseDocument(InputStream input)
static TargetDefinitionFile	read(File file)
static TargetDefinitionFile	read(URI uri)
String	toString()
static void	writeDocument(Document document, OutputStream outputStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.tycho.targetplatform.TargetDefinition

equals, hashCode

Field Details

ELEMENT_LOCATIONS

public static final String ELEMENT_LOCATIONS

See Also:

• Constant Field Values

FILE_EXTENSION

public static final String FILE_EXTENSION

See Also:

• Constant Field Values

APPLICATION_TARGET

public static final String APPLICATION_TARGET

See Also:

• Constant Field Values

Method Details

parseDocument

public static Document parseDocument(InputStream input)
                              throws ParserConfigurationException,
SAXException,
IOException

Throws:

ParserConfigurationException

SAXException

IOException

writeDocument

public static void writeDocument(Document document,
 OutputStream outputStream)
                          throws IOException

Throws:

IOException

getLocations

public List<? extends TargetDefinition.Location> getLocations()

Specified by:

getLocations in interface TargetDefinition

hasIncludedBundles

public boolean hasIncludedBundles()

Description copied from interface: TargetDefinition

Returns true if the target definition specifies an explicit list of bundles to include (i.e. an <includeBundles> in target definition files).

Specified by:

hasIncludedBundles in interface TargetDefinition

getOrigin

public String getOrigin()

Description copied from interface: TargetDefinition

Returns the origin of the target definition, e.g. a file path. Used for debugging only.

Specified by:

getOrigin in interface TargetDefinition

read

public static TargetDefinitionFile read(File file)

read

public static TargetDefinitionFile read(URI uri)

parse

public static TargetDefinitionFile parse(Document document,
 String origin)

getTargetEE

public String getTargetEE()

Description copied from interface: TargetDefinition

Returns the value of the targetJRE in *.target file if it's a known EE name. null will be returned otherwise.

Specified by:

getTargetEE in interface TargetDefinition

toString

public String toString()

Overrides:

toString in class Object

implicitDependencies

public Stream<TargetDefinition.ImplicitDependency> implicitDependencies()

Specified by:

implicitDependencies in interface TargetDefinition

Returns:

a stream of implicit dependencies defined in the target to add as an additional dependency to every project

listTargetFiles

public static File[] listTargetFiles(File folder)

List all target files in the given folder

Parameters:

folder -

Returns:

the found target files or empty array if nothing was found, folder is not a directory or the directory could not be read

isTargetFile

public static boolean isTargetFile(File file)

Parameters:

file -

Returns:

true if the given files likely denotes are targetfile based on file naming, false otherwise