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

All Superinterfaces:

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

public interface JarFileRef
extends XmlContextNode, JpaStructureNode, PersistentTypeContainer

Context model corresponding to the XML resource model XmlJarFileRef, which corresponds to the jar-file element in the persistence.xml file.

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.

Since:

2.2

Version:

2.3

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.

Fields inherited from interface org.eclipse.jpt.jpa.core.context.persistence.PersistentTypeContainer

TRANSFORMER

Method Summary

boolean	containsOffset(int textOffset) Return whether the text representation of the JAR file ref contains the specified text offset.
java.lang.Iterable<org.eclipse.text.edits.ReplaceEdit>	createReplaceFolderEdits(org.eclipse.core.resources.IFolder originalFolder, java.lang.String newName) Create ReplaceEdits for renaming any references to the originalFolder to the newName.
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.
XmlJarFileRef	getXmlJarFileRef()
void	setFileName(java.lang.String fileName) Set the file name of the jar file ref.

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

getValidationTextRange, validate

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

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

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

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

getAdapter

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

getResource

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

dispose, getId, getResourceType, getSelectionTextRange, getStructureNode

Methods inherited from interface org.eclipse.jpt.jpa.core.context.persistence.PersistentTypeContainer

getPersistentType, getPersistentTypes

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.

createReplaceFolderEdits

java.lang.Iterable<org.eclipse.text.edits.ReplaceEdit> createReplaceFolderEdits(org.eclipse.core.resources.IFolder originalFolder,
                                                                                java.lang.String newName)

Create ReplaceEdits for renaming any references to the originalFolder to the newName. The originalFolder has not yet been renamed.

getXmlJarFileRef

XmlJarFileRef getXmlJarFileRef()

containsOffset

boolean containsOffset(int textOffset)

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