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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JpaStructureNode, JptResourceTypeReference, ManagedTypeContainer, Model, PersistentTypeContainer

public interface JarFileRef
extends 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

Nested Class Summary

static class

JarFileRef.JarFileTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaStructureNode

JpaStructureNode.ContextType

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.PersistentTypeContainer

PersistentTypeContainer.PersistentTypesTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.ManagedTypeContainer

ManagedTypeContainer.ContainsType, ManagedTypeContainer.ManagedTypesTransformer

Field Summary

static String	FILE_NAME_PROPERTY String constant associated with changes to the file name.
static String	JAR_FILE_PROPERTY String constant associated with changes to the JAR file.
static org.eclipse.jpt.common.utility.transformer.Transformer<JarFileRef,JarFile>	JAR_FILE_TRANSFORMER

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

STRUCTURE_CHILDREN_COLLECTION

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

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

TRANSFORMER

Method Summary

Iterable<ReplaceEdit>	createReplaceFolderEdits(IFolder originalFolder, String newName) Create ReplaceEdits for renaming any references to the originalFolder to the newName.
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.
Class<JarFileRef>	getStructureType() Return the structure node's type.
org.eclipse.jpt.jpa.core.resource.persistence.XmlJarFileRef	getXmlJarFileRef()
void	setFileName(String fileName) Set the file name of the jar file ref.

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

addRootStructureNodesTo, containsOffset, getContextType, getFullTextRange, getSelectionTextRange, getStructureChildren, getStructureChildrenSize, getStructureNode

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

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

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

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

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

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

getAdapter

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

getResourceType

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

getPersistentType, getPersistentTypes

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

getManagedType, getManagedTypes

Field Detail

FILE_NAME_PROPERTY

static final String FILE_NAME_PROPERTY

String constant associated with changes to the file name.

See Also:

Constant Field Values

JAR_FILE_PROPERTY

static final String JAR_FILE_PROPERTY

String constant associated with changes to the JAR file.

See Also:

Constant Field Values

JAR_FILE_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<JarFileRef,JarFile> JAR_FILE_TRANSFORMER

Method Detail

getStructureType

Class<JarFileRef> getStructureType()

Description copied from interface: JpaStructureNode

Return the structure node's type. This is used to find the appropriate UI provider for building the structure node's JPA Details page.

Specified by:

getStructureType in interface JpaStructureNode

getFileName

String getFileName()

Return the file name of the jar file ref.

setFileName

void setFileName(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

Iterable<ReplaceEdit> createReplaceFolderEdits(IFolder originalFolder,
                                               String newName)

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

getXmlJarFileRef

org.eclipse.jpt.jpa.core.resource.persistence.XmlJarFileRef getXmlJarFileRef()