org.eclipse.jpt.jaxb.core
Interface JaxbFile

All Superinterfaces:

IAdaptable, JaxbNode, Model

public interface JaxbFile
extends JaxbNode

A JAXB Project contains JAXB files for all files in the project that are relevant to the JAXB spec. 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:

3.0

Nested Class Summary

static class	JaxbFile.ContentIsKindOf
static class	JaxbFile.ResourceModelTransformer

Field Summary

static org.eclipse.jpt.common.utility.transformer.Transformer<JaxbFile,JptResourceModel>

RESOURCE_MODEL_TRANSFORMER

Method Summary

IContentType	getContentType() JAXB Return the JPA file's content type.
IFile	getFile() Return the JAXB file's Eclipse file.
JptResourceModel	getResourceModel() Return the resource model corresponding to the JPA file; typically a JPA compilation unit, a JPA XML resource, or a JPA package fragment root (JAR).
JptResourceModel	getResourceModel(IContentType contentType) Convenience method.

Methods inherited from interface org.eclipse.jpt.jaxb.core.JaxbNode

getJaxbProject, getParent, 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

Field Detail

RESOURCE_MODEL_TRANSFORMER

static final org.eclipse.jpt.common.utility.transformer.Transformer<JaxbFile,JptResourceModel> RESOURCE_MODEL_TRANSFORMER

Method Detail

getFile

IFile getFile()

Return the JAXB file's Eclipse file.

getContentType

IContentType getContentType()

JAXB Return the JPA file's content type.

getResourceModel

JptResourceModel getResourceModel()

Return the resource model corresponding to the JPA file; typically a JPA compilation unit, a JPA XML resource, or a JPA package fragment root (JAR).

getResourceModel

JptResourceModel getResourceModel(IContentType contentType)

Convenience method. Return the resource model corresponding to the JPA file if the file's content is a "kind-of" the specified content type; otherwise, return null. This is useful when a client has looked up the JPA file via a file name [and assumed content type].

See Also:

getResourceModel()