Dali Provisional API
Release 3.2

org.eclipse.jpt.jaxb.eclipselink.core.context.oxm
Interface OxmXmlBindings

All Superinterfaces:
IAdaptable, JaxbContextNode, JaxbNode, JptResourceTypeReference, Model, XmlAccessOrderHolder, XmlAccessTypeHolder

public interface OxmXmlBindings
extends JaxbContextNode, XmlAccessTypeHolder, XmlAccessOrderHolder

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

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
JptResourceTypeReference.ResourceTypeTransformer
 
Field Summary
static String IMPLIED_PACKAGE_NAME_PROPERTY
          string associated with impliedPackageName property
static String JAVA_TYPES_LIST
           
static String SPECIFIED_PACKAGE_NAME_PROPERTY
          string associated with specifiedPackageName property
static String XML_ENUMS_LIST
           
static String XML_MAPPING_METADATA_COMPLETE_PROPERTY
           
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessTypeHolder
DEFAULT_ACCESS_TYPE_PROPERTY, SPECIFIED_ACCESS_TYPE_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessOrderHolder
DEFAULT_ACCESS_ORDER_PROPERTY, SPECIFIED_ACCESS_ORDER_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
RESOURCE_TYPE_TRANSFORMER
 
Method Summary
 OxmJavaType addJavaType(int index)
           
 OxmXmlEnum addXmlEnum(int index)
           
 org.eclipse.jpt.jaxb.eclipselink.core.resource.oxm.EXmlBindings getEXmlBindings()
           
 String getImpliedPackageName()
          return the package name implied by querying java types included in this document
 OxmJavaType getJavaType(int index)
           
 OxmJavaType getJavaType(String qualifiedName)
          Return the first java type with the given qualified name
 org.eclipse.jpt.common.utility.iterable.ListIterable<OxmJavaType> getJavaTypes()
           
 int getJavaTypesSize()
           
 OxmFile getOxmFile()
           
 String getPackageName()
          return the specified package name if specified, otherwise the implied package name
 String getQualifiedName(String childTypeName)
          Return a qualified name for the given (qualified or unqualified) child type name, prepending a package name if applicable
 String getSpecifiedPackageName()
          return the package name specified on the xml-bindings node
 OxmTypeMapping getTypeMapping(String typeName)
          Return *first* type mapping with the given name
 Iterable<OxmTypeMapping> getTypeMappings()
           
 OxmXmlEnum getXmlEnum(int index)
           
 OxmXmlEnum getXmlEnum(String qualifiedName)
          Return the first xml enum with the given qualified name
 org.eclipse.jpt.common.utility.iterable.ListIterable<OxmXmlEnum> getXmlEnums()
           
 int getXmlEnumsSize()
           
 OxmXmlSchema getXmlSchema()
           
 boolean isXmlMappingMetadataComplete()
           
 void removeJavaType(int index)
           
 void removeXmlEnum(int index)
           
 void setSpecifiedPackageName(String packageName)
          set the package name on the xml-bindings node
 void setXmlMappingMetadataComplete(boolean newValue)
           
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessTypeHolder
getAccessType, getDefaultAccessType, getSpecifiedAccessType, setSpecifiedAccessType
 
Methods inherited from interface org.eclipse.jpt.jaxb.core.context.XmlAccessOrderHolder
getAccessOrder, getDefaultAccessOrder, getSpecifiedAccessOrder, setSpecifiedAccessOrder
 
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_MAPPING_METADATA_COMPLETE_PROPERTY

static final String XML_MAPPING_METADATA_COMPLETE_PROPERTY
See Also:
Constant Field Values

SPECIFIED_PACKAGE_NAME_PROPERTY

static final String SPECIFIED_PACKAGE_NAME_PROPERTY
string associated with specifiedPackageName property

See Also:
Constant Field Values

IMPLIED_PACKAGE_NAME_PROPERTY

static final String IMPLIED_PACKAGE_NAME_PROPERTY
string associated with impliedPackageName property

See Also:
Constant Field Values

XML_ENUMS_LIST

static final String XML_ENUMS_LIST
See Also:
Constant Field Values

JAVA_TYPES_LIST

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

getEXmlBindings

org.eclipse.jpt.jaxb.eclipselink.core.resource.oxm.EXmlBindings getEXmlBindings()

getOxmFile

OxmFile getOxmFile()

isXmlMappingMetadataComplete

boolean isXmlMappingMetadataComplete()

setXmlMappingMetadataComplete

void setXmlMappingMetadataComplete(boolean newValue)

getSpecifiedPackageName

String getSpecifiedPackageName()
return the package name specified on the xml-bindings node


setSpecifiedPackageName

void setSpecifiedPackageName(String packageName)
set the package name on the xml-bindings node


getImpliedPackageName

String getImpliedPackageName()
return the package name implied by querying java types included in this document


getPackageName

String getPackageName()
return the specified package name if specified, otherwise the implied package name


getQualifiedName

String getQualifiedName(String childTypeName)
Return a qualified name for the given (qualified or unqualified) child type name, prepending a package name if applicable


getXmlSchema

OxmXmlSchema getXmlSchema()

getXmlEnums

org.eclipse.jpt.common.utility.iterable.ListIterable<OxmXmlEnum> getXmlEnums()

getXmlEnumsSize

int getXmlEnumsSize()

getXmlEnum

OxmXmlEnum getXmlEnum(int index)

addXmlEnum

OxmXmlEnum addXmlEnum(int index)

removeXmlEnum

void removeXmlEnum(int index)

getXmlEnum

OxmXmlEnum getXmlEnum(String qualifiedName)
Return the first xml enum with the given qualified name


getJavaTypes

org.eclipse.jpt.common.utility.iterable.ListIterable<OxmJavaType> getJavaTypes()

getJavaTypesSize

int getJavaTypesSize()

getJavaType

OxmJavaType getJavaType(int index)

addJavaType

OxmJavaType addJavaType(int index)

removeJavaType

void removeJavaType(int index)

getJavaType

OxmJavaType getJavaType(String qualifiedName)
Return the first java type with the given qualified name


getTypeMappings

Iterable<OxmTypeMapping> getTypeMappings()

getTypeMapping

OxmTypeMapping getTypeMapping(String typeName)
Return *first* type mapping with the given name


Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.