org.eclipse.jpt.core.context.persistence
Interface JarFileRef

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, JpaStructureNode, Model, XmlContextNode

public interface JarFileRef
extends XmlContextNode, JpaStructureNode

This is the context model corresponding to the persistence resource model XmlJarRef, which corresponds to the 'jar-file' tag in the persistence.xml. Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Field Summary

static java.lang.String	FILE_NAME_PROPERTY String constant associated with changes to the file name.
static java.lang.String	JAR_FILE_PROPERTY String constant associated with changes to the JAR file.

Method Summary

boolean	containsOffset(int textOffset) Return whether the text representation of the JAR file ref contains the specified text offset.
java.lang.String	getFileName() Return the file name of the jar file ref.
JarFile	getJarFile() Return the JAR file ref's JAR file corresponding to the file name.
PersistentType	getPersistentType(java.lang.String typeName) Return the persistent type, as listed in the JAR file, with the specified name.
void	setFileName(java.lang.String fileName) Set the file name of the jar file ref.
void	update(XmlJarFileRef xmlJarFileRef) Update the context JAR file ref to match the specified XML JAR file ref.

Methods inherited from interface org.eclipse.jpt.core.context.XmlContextNode

getValidationTextRange, validate

Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate

Methods inherited from interface org.eclipse.jpt.core.JpaNode

getJpaProject, getParent

Methods inherited from interface org.eclipse.jpt.utility.model.Model

addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.core.IResourcePart

getResource

Methods inherited from interface org.eclipse.jpt.core.JpaStructureNode

dispose, getContentType, getId, getSelectionTextRange, getStructureNode

Field Detail

FILE_NAME_PROPERTY

static final java.lang.String FILE_NAME_PROPERTY

String constant associated with changes to the file name.

See Also:

Constant Field Values

JAR_FILE_PROPERTY

static final java.lang.String JAR_FILE_PROPERTY

String constant associated with changes to the JAR file.

See Also:

Constant Field Values

Method Detail

getFileName

java.lang.String getFileName()

Return the file name of the jar file ref.

setFileName

void setFileName(java.lang.String fileName)

Set the file name of the jar file ref.

getJarFile

JarFile getJarFile()

Return the JAR file ref's JAR file corresponding to the file name.

update

void update(XmlJarFileRef xmlJarFileRef)

Update the context JAR file ref to match the specified XML JAR file ref.

See Also:

JpaProject.update()

getPersistentType

PersistentType getPersistentType(java.lang.String typeName)

Return the persistent type, as listed in the JAR file, with the specified name. Return null if it does not exists.

containsOffset

boolean containsOffset(int textOffset)

Return whether the text representation of the JAR file ref contains the specified text offset.