| java.lang.Object
 com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl
com.sun.tools.xjc.reader.xmlschema.bindinfo.BIProperty
| BIProperty | | final public class BIProperty extends AbstractDeclarationImpl (Code) | | Property customization.
This customization turns an arbitrary schema component
into a Java property (some restrictions apply.)
All the getter methods (such as getBaseType or
getBindStyle) honors the delegation chain of
property customization specified in the spec. Namely,
if two property customizations are attached to an attribute
use and an attribute decl, then anything unspecified in the
attribute use defaults to attribute decl.
Property customizations are acknowledged
(1) when they are actually used, and
(2) when they are given at the component, which is mapped to a class.
(so-called "point of declaration" customization)
author:
Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com) |
| Field Summary | |
| final public static QName | NAME
Name of this declaration. |
| Method Summary | |
| public CAttributePropertyInfo | createAttributeProperty(XSAttributeUse use, TypeUse tu)
| | public CPropertyInfo | createElementOrReferenceProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)
| | public CElementPropertyInfo | createElementProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)
Parameters:
defaultName - If the name is not customized, this name will be usedas the default. | | public CReferencePropertyInfo | createReferenceProperty(String defaultName, boolean forConstant, XSComponent source, RawTypeSet types, boolean isMixed)
| | public CValuePropertyInfo | createValueProperty(String defaultName, boolean forConstant, XSComponent source, TypeUse tu, QName typeName)
| | public JType | getBaseType()
| | public Collection<BIDeclaration> | getChildren()
| | CollectionTypeAttribute | getCollectionType()
Gets the realization of this field. | | public BIConversion | getConv()
| | public static BIProperty | getCustomization(XSComponent c)
Finds a property customization that describes how the given
component should be mapped to a property (if it's mapped to
a property at all.)
Consider an attribute use that does NOT carry a property
customization. | | protected BIProperty | getDefault()
Finds a BIProperty which this object should delegate to. | | public String | getJavadoc()
Gets the associated javadoc. | | public QName | getName()
| | public OptionalPropertyMode | getOptionalPropertyMode()
| | public String | getPropertyName(boolean forConstant)
Returns the customized property name.
This method honors the "enableJavaNamingConvention" customization
and formats the property name accordingly if necessary.
Thus the caller should NOT apply the XML-to-Java name
conversion algorithm to the value returned from this method.
Parameters:
forConstant - If the property name is intended for a constant property name,set to true. | | public boolean | isConstantProperty()
Gets the inherited value of the "fixedAttrToConstantProperty" customization. | | public void | markAsAcknowledged()
| | void | setGenerateIsSetMethod(boolean b)
| | public void | setParent(BindInfo parent)
|
| NAME | | final public static QName NAME(Code) | | Name of this declaration.
|
| BIProperty | | protected BIProperty()(Code) | | |
| createElementProperty | | public CElementPropertyInfo createElementProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)(Code) | |
Parameters:
defaultName - If the name is not customized, this name will be usedas the default. Note that the name conversion MUSTbe applied before this method is called if necessary.
Parameters:
source - Source schema component from which a field is built. |
| getCustomization | | public static BIProperty getCustomization(XSComponent c)(Code) | | Finds a property customization that describes how the given
component should be mapped to a property (if it's mapped to
a property at all.)
Consider an attribute use that does NOT carry a property
customization. This schema component is nonetheless considered
to carry a (sort of) implicit property customization, whose values
are defaulted.
This method can be think of the method that returns this implied
property customization.
Note that this doesn't mean the given component needs to be
mapped to a property. But if it does map to a property, it needs
to follow this customization.
I think this semantics is next to non-sense but I couldn't think
of any other way to follow the spec.
Parameters:
c - A customization effective on this component will be returned.Can be null just to get the global customization.Always return non-null valid object. |
| getDefault | | protected BIProperty getDefault()(Code) | | Finds a BIProperty which this object should delegate to.
always return non-null for normal BIProperties.If this object is contained in the BIGlobalBinding, thenthis method returns null to indicate that there's no more default. |
| getJavadoc | | public String getJavadoc()(Code) | | Gets the associated javadoc.
null if none is specfieid. |
| getPropertyName | | public String getPropertyName(boolean forConstant)(Code) | | Returns the customized property name.
This method honors the "enableJavaNamingConvention" customization
and formats the property name accordingly if necessary.
Thus the caller should NOT apply the XML-to-Java name
conversion algorithm to the value returned from this method.
Parameters:
forConstant - If the property name is intended for a constant property name,set to true. This will change the resultThis method can return null if the customization doesn'tspecify the name. |
| isConstantProperty | | public boolean isConstantProperty()(Code) | | Gets the inherited value of the "fixedAttrToConstantProperty" customization.
Note that returning true from this method doesn't necessarily mean
that a property needs to be mapped to a constant property.
It just means that it's mapped to a constant property
if an attribute use carries a fixed value.
I don't like this semantics but that's what the spec implies.
|
| markAsAcknowledged | | public void markAsAcknowledged()(Code) | | |
| setGenerateIsSetMethod | | void setGenerateIsSetMethod(boolean b)(Code) | | |
|
|