Dali Provisional API
Release 3.2

org.eclipse.jpt.jaxb.core.context
Interface JaxbTypeMapping

All Superinterfaces:
IAdaptable, JaxbContextNode, JaxbNode, JptResourceTypeReference, Model
All Known Subinterfaces:
ELClassMapping, JavaClassMapping, JavaEnumMapping, JavaTypeMapping, JaxbClassMapping, JaxbEnumMapping, OxmJavaType, OxmTypeMapping, OxmXmlEnum

public interface JaxbTypeMapping
extends JaxbContextNode

Represents mapping metadata on a JavaType (specified or implied).

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.1

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
JptResourceTypeReference.ResourceTypeTransformer
 
Field Summary
static String XML_ROOT_ELEMENT_PROPERTY
           
static String XML_SEE_ALSO_PROPERTY
           
static String XML_TRANSIENT_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
RESOURCE_TYPE_TRANSFORMER
 
Method Summary
 JaxbPackage getJaxbPackage()
           
 JaxbQName getQName()
           
 Iterable<String> getReferencedXmlTypeNames()
          Return all directly referenced types, fully qualified.
 TypeKind getTypeKind()
          Return the kind of type represented.
 TypeName getTypeName()
          Return the type's name object
 XmlRootElement getXmlRootElement()
           
 XmlSeeAlso getXmlSeeAlso()
           
 XsdTypeDefinition getXsdTypeDefinition()
           
 boolean hasRootElementInHierarchy()
          Return true if this class or a subclass (if it can have subclasses) has a root element defined
 boolean isXmlTransient()
           
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.JaxbContextNode
getCompletionProposals, getContextRoot, getValidationTextRange, synchronizeWithResourceModel, update, validate
 
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
 
Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
getResourceType
 

Field Detail

XML_TRANSIENT_PROPERTY

static final String XML_TRANSIENT_PROPERTY
See Also:
Constant Field Values

XML_ROOT_ELEMENT_PROPERTY

static final String XML_ROOT_ELEMENT_PROPERTY
See Also:
Constant Field Values

XML_SEE_ALSO_PROPERTY

static final String XML_SEE_ALSO_PROPERTY
See Also:
Constant Field Values
Method Detail

getTypeKind

TypeKind getTypeKind()
Return the kind of type represented. JaxbTypeMappings of TypeKind CLASS may safely be cast to JaxbClassMapping JaxbTypeMappings of TypeKind ENUM may safely be cast to JaxbEnumMapping


getTypeName

TypeName getTypeName()
Return the type's name object


getJaxbPackage

JaxbPackage getJaxbPackage()

isXmlTransient

boolean isXmlTransient()

getQName

JaxbQName getQName()

getXmlRootElement

XmlRootElement getXmlRootElement()

getXmlSeeAlso

XmlSeeAlso getXmlSeeAlso()

getReferencedXmlTypeNames

Iterable<String> getReferencedXmlTypeNames()
Return all directly referenced types, fully qualified. (Used for constructing Jaxb context)


getXsdTypeDefinition

XsdTypeDefinition getXsdTypeDefinition()

hasRootElementInHierarchy

boolean hasRootElementInHierarchy()
Return true if this class or a subclass (if it can have subclasses) has a root element defined


Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.