|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl
com.sun.tools.xjc.reader.xmlschema.bindinfo.BIProperty
public final class BIProperty
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)
Field Summary | |
---|---|
static QName |
NAME
Name of this declaration. |
Fields inherited from class com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl |
---|
loc, parent |
Constructor Summary | |
---|---|
protected |
BIProperty()
|
|
BIProperty(Locator loc,
String _propName,
String _javadoc,
com.sun.tools.xjc.reader.xmlschema.bindinfo.BIProperty.BaseTypeBean _baseType,
CollectionTypeAttribute collectionType,
Boolean isConst,
OptionalPropertyMode optionalProperty,
Boolean genElemProp)
|
Method Summary | |
---|---|
CAttributePropertyInfo |
createAttributeProperty(XSAttributeUse use,
TypeUse tu)
|
CPropertyInfo |
createElementOrReferenceProperty(String defaultName,
boolean forConstant,
XSParticle source,
RawTypeSet types)
|
CElementPropertyInfo |
createElementProperty(String defaultName,
boolean forConstant,
XSParticle source,
RawTypeSet types)
|
CReferencePropertyInfo |
createReferenceProperty(String defaultName,
boolean forConstant,
XSComponent source,
RawTypeSet types,
boolean isMixed)
|
CValuePropertyInfo |
createValueProperty(String defaultName,
boolean forConstant,
XSComponent source,
TypeUse tu,
QName typeName)
|
com.sun.codemodel.JType |
getBaseType()
|
Collection<BIDeclaration> |
getChildren()
Gets child BIDeclaration s if any. |
(package private) CollectionTypeAttribute |
getCollectionType()
Gets the realization of this field. |
BIConversion |
getConv()
|
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.) |
protected BIProperty |
getDefault()
Finds a BIProperty which this object should delegate to. |
String |
getJavadoc()
Gets the associated javadoc. |
QName |
getName()
Gets the name of this binding declaration, which is the same as the tag name of the binding element. |
OptionalPropertyMode |
getOptionalPropertyMode()
|
String |
getPropertyName(boolean forConstant)
Returns the customized property name. |
boolean |
isConstantProperty()
Gets the inherited value of the "fixedAttrToConstantProperty" customization. |
void |
markAsAcknowledged()
Marks this declaration to be acknowledged -- either actually used or the existence is admitted (for example when a property customization is given at the point of definition.) |
(package private) void |
setGenerateIsSetMethod(boolean b)
|
void |
setParent(BindInfo parent)
Sets the parent BindInfo object of this declaration. |
Methods inherited from class com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl |
---|
getBuilder, getCodeModel, getLocation, getOwner, isAcknowledged, onSetOwner |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final QName NAME
Constructor Detail |
---|
public BIProperty(Locator loc, String _propName, String _javadoc, com.sun.tools.xjc.reader.xmlschema.bindinfo.BIProperty.BaseTypeBean _baseType, CollectionTypeAttribute collectionType, Boolean isConst, OptionalPropertyMode optionalProperty, Boolean genElemProp)
protected BIProperty()
Method Detail |
---|
public Collection<BIDeclaration> getChildren()
BIDeclaration
BIDeclaration
s if any.
getChildren
in interface BIDeclaration
getChildren
in class AbstractDeclarationImpl
public void setParent(BindInfo parent)
BIDeclaration
This method can be only called from BindInfo
,
and only once. This is a good opportunity to do some
follow-up initialization after JAXB unmarshalling
populated BIDeclaration
.
setParent
in interface BIDeclaration
setParent
in class AbstractDeclarationImpl
public String getPropertyName(boolean forConstant)
forConstant
- If the property name is intended for a constant property name,
set to true. This will change the result
public String getJavadoc()
public com.sun.codemodel.JType getBaseType()
CollectionTypeAttribute getCollectionType()
void setGenerateIsSetMethod(boolean b)
public OptionalPropertyMode getOptionalPropertyMode()
public boolean isConstantProperty()
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.
public CValuePropertyInfo createValueProperty(String defaultName, boolean forConstant, XSComponent source, TypeUse tu, QName typeName)
public CAttributePropertyInfo createAttributeProperty(XSAttributeUse use, TypeUse tu)
public CElementPropertyInfo createElementProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)
defaultName
- If the name is not customized, this name will be used
as the default. Note that the name conversion MUST
be applied before this method is called if necessary.source
- Source schema component from which a field is built.public CReferencePropertyInfo createReferenceProperty(String defaultName, boolean forConstant, XSComponent source, RawTypeSet types, boolean isMixed)
public CPropertyInfo createElementOrReferenceProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)
public void markAsAcknowledged()
BIDeclaration
Declarations that are not acknowledged will be considered as an error.
markAsAcknowledged
in interface BIDeclaration
markAsAcknowledged
in class AbstractDeclarationImpl
protected BIProperty getDefault()
public static BIProperty getCustomization(XSComponent c)
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.
c
- A customization effective on this component will be returned.
Can be null just to get the global customization.
public QName getName()
BIDeclaration
public BIConversion getConv()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |