org.eclipse.mtj.core.sdk.device.midp.library
Interface ILibrary

All Superinterfaces:

IPersistable

public interface ILibrary
extends IPersistable

Represents a library in the device's classpath. A library is capable of providing further metadata about that specified jar file.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the MTJ team.

Since:

1.0

Method Summary

API	getAPI(APIType apiType) Return the first API with a type matching the specified API type or null if none can be found.
API[]	getAPIs() Return the APIs associated with this library instance.
API	getConfiguration() Return the configuration API or null if this library does not provide a configuration.
API	getProfile() Return the profile API or null if this library does not provide a configuration.
boolean	hasConfiguration() Return a boolean indicating whether this library contains a configuration.
boolean	hasProfile() Return a boolean indicating whether this library contains a profile.
void	setAccessRules(IAccessRule[] accessRules) Set the access rules for this library.
void	setApis(API[] apis)
void	setJavadocURL(URL javadocURL)
void	setLibraryFile(File libraryFile) Sets the file that makes up this library.
void	setSourceAttachmentPath(IPath sourceAttachmentPath)
void	setSourceAttachmentRootPath(IPath sourceAttachmentRootPath)
IClasspathEntry	toClasspathEntry() Return the library as an instance of IClasspathEntry.
File	toFile() Return the library as an instance of java.io.File.
URL	toURL() Return the library as an instance of java.net.URL.

Methods inherited from interface org.eclipse.mtj.core.persistence.IPersistable

loadUsing, storeUsing

Method Detail

getAPIs

API[] getAPIs()

Return the APIs associated with this library instance.

Returns:

getAPI

API getAPI(APIType apiType)

Return the first API with a type matching the specified API type or null if none can be found.

Parameters:

apiType -

Returns:

getConfiguration

API getConfiguration()

Return the configuration API or null if this library does not provide a configuration.

Returns:

getProfile

API getProfile()

Return the profile API or null if this library does not provide a configuration.

Returns:

hasConfiguration

boolean hasConfiguration()

Return a boolean indicating whether this library contains a configuration.

Returns:

hasProfile

boolean hasProfile()

Return a boolean indicating whether this library contains a profile.

Returns:

toClasspathEntry

IClasspathEntry toClasspathEntry()

Return the library as an instance of IClasspathEntry.

Returns:

toFile

File toFile()

Return the library as an instance of java.io.File.

Returns:

toURL

URL toURL()

Return the library as an instance of java.net.URL.

Returns:

setAccessRules

void setAccessRules(IAccessRule[] accessRules)

Set the access rules for this library.

Parameters:

accessRules -

setApis

void setApis(API[] apis)

Parameters:

api - The apis to set.

setJavadocURL

void setJavadocURL(URL javadocURL)

Parameters:

javadocURL - The javadocURL to set.

setLibraryFile

void setLibraryFile(File libraryFile)

Sets the file that makes up this library.

Parameters:

libraryFile - The libraryFile to set.

setSourceAttachmentPath

void setSourceAttachmentPath(IPath sourceAttachmentPath)

Parameters:

sourceAttachmentPath - The sourceAttachmentPath to set.

setSourceAttachmentRootPath

void setSourceAttachmentRootPath(IPath sourceAttachmentRootPath)

Parameters:

sourceAttachmentRootPath - The sourceAttachmentRootPath to set.