Mobile Tools for Java
Release 1.0

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

All Superinterfaces:
IPersistable
All Known Subinterfaces:
IMIDPLibrary

public interface ILibrary
extends IPersistable

Represents a library that is associated to a device. The library is directly related to a JAR file and also to a list of IAPI's.

Since:
1.0

Field Summary
 
Fields inherited from interface org.eclipse.mtj.core.persistence.IPersistable
CLASS_PERSISTABLE_ATTRIBUTE, ID_PERSISTABLE_ATTRIBUTE, KEY_PERSISTABLE_ATTRIBUTE, PROPERTY_PERSISTABLE_ELEMENT, REFID_PERSISTABLE_ATTRIBUTE, VALUE_PERSISTABLE_ATTRIBUTE
 
Method Summary
 List<IAccessRule> getAccessRules()
          Returns the possibly empty list of access rules for this library.
 List<? extends IAPI> getAPIs()
          Return the APIs associated with this library instance.
 IPath getSourceAttachmentPath()
          Returns the path to the source archive or folder associated with this library, or null if this classpath entry has no source attachment.
 IPath getSourceAttachmentRootPath()
          Returns the path within the source archive or folder where package fragments are located.
 void setAccessRules(List<IAccessRule> accessRules)
          Set the list of access rules for this library.
 void setApis(List<? extends IAPI> apis)
          Set the APIs associated with this library instance.
 void setJavadocURL(URL javadocURL)
          Set the URL containing the path to the javadoc describing this library.
 void setLibraryFile(File libraryFile)
          Sets the jar file represented by this library.
 void setSourceAttachmentPath(IPath sourceAttachmentPath)
          Set the path to the source archive or folder associated with this Library.
 void setSourceAttachmentRootPath(IPath sourceAttachmentRootPath)
          Set the path within the source archive or folder where package fragments are located.
 IClasspathEntry toClasspathEntry()
          Return the library as an instance of IClasspathEntry.
 File toFile()
          Return the jar file represented by this library.
 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

List<? extends IAPI> getAPIs()
Return the APIs associated with this library instance.

Returns:
the list of APIs available in this library or null if none was specified.

setAccessRules

void setAccessRules(List<IAccessRule> accessRules)
Set the list of access rules for this library.

Parameters:
accessRules - the list with all access rules for this library.

setApis

void setApis(List<? extends IAPI> apis)
Set the APIs associated with this library instance.

Parameters:
api - the list of APIs to be associated with this library.

setJavadocURL

void setJavadocURL(URL javadocURL)
Set the URL containing the path to the javadoc describing this library.

Parameters:
javadocURL - the URL containing the path to the javadoc describing this library.

setLibraryFile

void setLibraryFile(File libraryFile)
Sets the jar file represented by this library.

Parameters:
libraryFile - the jar file represented by this library.

setSourceAttachmentPath

void setSourceAttachmentPath(IPath sourceAttachmentPath)
Set the path to the source archive or folder associated with this Library.

Parameters:
sourceAttachmentPath - the path to the source archive or folder

setSourceAttachmentRootPath

void setSourceAttachmentRootPath(IPath sourceAttachmentRootPath)
Set the path within the source archive or folder where package fragments are located. An empty path indicates that packages are located at the root of the source archive or folder.

Parameters:
sourceAttachmentRootPath - the path within the source archive or folder, or null if not applicable.

toClasspathEntry

IClasspathEntry toClasspathEntry()
Return the library as an instance of IClasspathEntry.

Returns:
the library as an instance of IClasspathEntry.

toFile

File toFile()
Return the jar file represented by this library.

Returns:
the jar file represented by this library.

toURL

URL toURL()
Return the library as an instance of java.net.URL.

Returns:
An absolute, hierarchical URL with a scheme equal to "file", a path representing this library pathname, and undefined authority, query, and fragment components.

getSourceAttachmentPath

IPath getSourceAttachmentPath()
Returns the path to the source archive or folder associated with this library, or null if this classpath entry has no source attachment.

Returns:
the path to the source archive or folder, or null if none

getSourceAttachmentRootPath

IPath getSourceAttachmentRootPath()
Returns the path within the source archive or folder where package fragments are located. An empty path indicates that packages are located at the root of the source archive or folder.

Returns:
the path within the source archive or folder, or null if not applicable

getAccessRules

List<IAccessRule> getAccessRules()
Returns the possibly empty list of access rules for this library.

Returns:
the possibly empty list of access rules for this library.

Mobile Tools for Java
Release 1.0