JAXB OSGI 4.0.9 · com.sun.tools.xjc.reader.xmlschema.bindinfo.BIProperty

Modifier and Type	Class and Description
public static class	BIProperty.BaseTypeBean

Modifier and Type	Field and Description
private BIProperty.BaseTypeBean	baseType
private CollectionTypeAttribute	collectionType
private static final XSFunction<XSComponent>	defaultCustomizationFinder
private Boolean	generateElementProperty
private boolean	generateFailFastSetterMethod
private final XSFinder	hasFixedValue Function object that returns true if a component has a fixed value constraint.
private Boolean	isConstantProperty
private String	javadoc
private String	name
public static final QName	NAME Name of this declaration.
private OptionalPropertyMode	optionalProperty

Access	Constructor and Description
public	BIProperty(Locator loc, String _propName, String _javadoc, BIProperty.BaseTypeBean _baseType, CollectionTypeAttribute collectionType, Boolean isConst, OptionalPropertyMode optionalProperty, Boolean genElemProp)
protected	BIProperty()

Method Summary

Modifier and Type	Method and Description
private static String	concat(String s1, String s2)
private void	constantPropertyErrorCheck()
public CAttributePropertyInfo	createAttributeProperty(XSAttributeUse use, TypeUse tu)
public CReferencePropertyInfo	createContentExtendedMixedReferenceProperty(String defaultName, XSComponent source, RawTypeSet types)
public CReferencePropertyInfo	createDummyExtendedMixedReferenceProperty(String defaultName, XSComponent source, RawTypeSet types)
public CPropertyInfo	createElementOrReferenceProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)
public CElementPropertyInfo	createElementProperty(String 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. defaultName, boolean forConstant, XSParticle Source schema component from which a field is built. source, RawTypeSet types)
public CReferencePropertyInfo	createReferenceProperty(String defaultName, boolean forConstant, XSComponent source, RawTypeSet types, boolean isMixed, boolean dummy, boolean content, boolean isMixedExtended)
public CValuePropertyInfo	createValueProperty(String defaultName, boolean forConstant, XSComponent source, TypeUse tu, QName typeName)
private Boolean	generateElementProperty() If true, the property will automatically be a reference property.
public JType	getBaseType()
public Collection<BIDeclaration>	getChildren() Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.getChildren. Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getChildren. Gets child s if any.
pack-priv CollectionTypeAttribute	Returns: Always return non-null. getCollectionType() Gets the realization of this field.
public BIConversion	getConv()
public static BIProperty	Returns: Always return non-null valid object. getCustomization(XSComponent A customization effective on this component will be returned. Can be null just to get the global customization. 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.
private CCustomizations	getCustomizations(XSComponent src)
private CCustomizations	getCustomizations(XSComponent... src)
private CCustomizations	getCustomizations(XSAttributeUse src)
private CCustomizations	getCustomizations(XSParticle src)
protected BIProperty	Returns: always return non-null for normal BIProperties. If this object is contained in the BIGlobalBinding, then this method returns null to indicate that there's no more default. getDefault() Finds a BIProperty which this object should delegate to.
private static BIProperty	getDefault(BGMBuilder builder, XSComponent c)
public String	Returns: null if none is specfieid. getJavadoc() Gets the associated javadoc.
public QName	getName() Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getName. Gets the name of this binding declaration, which is the same as the tag name of the binding element.
public OptionalPropertyMode	getOptionalPropertyMode()
public String	Returns: This method can return null if the customization doesn't specify the name. getPropertyName(boolean If the property name is intended for a constant property name, set to true. This will change the result forConstant) Returns the customized property name.
public boolean	isConstantProperty() Gets the inherited value of the "fixedAttrToConstantProperty" customization.
public void	markAsAcknowledged() Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.markAsAcknowledged. Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.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.) Declarations that are not acknowledged will be considered as an error.
pack-priv void	setGenerateIsSetMethod(boolean b)
public void	setParent(BindInfo parent) Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.setParent. Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.setParent. Sets the parent BindInfo object of this declaration.
private <T extends CPropertyInfo> T	wrapUp(T prop, XSComponent source) Common finalization of `CPropertyInfo` for the create***Property methods.

Inherited from com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl:: getBuilder getCodeModel getLocation getOwner isAcknowledged onSetOwner

baseType	back to summary
private BIProperty.BaseTypeBean baseType Annotations @XmlElement

collectionType	back to summary
private CollectionTypeAttribute collectionType Annotations @XmlAttribute

defaultCustomizationFinder	back to summary
private static final XSFunction<XSComponent> defaultCustomizationFinder

generateElementProperty	back to summary
private Boolean generateElementProperty Annotations @XmlAttribute

generateFailFastSetterMethod	back to summary
private boolean generateFailFastSetterMethod Annotations @XmlAttribute

hasFixedValue	back to summary
private final XSFinder hasFixedValue Function object that returns true if a component has a fixed value constraint.

isConstantProperty	back to summary
private Boolean isConstantProperty Annotations @XmlAttribute name:fixedAttributeAsConstantProperty

javadoc	back to summary
private String javadoc Annotations @XmlElement

name	back to summary
private String name Annotations @XmlAttribute

NAME	back to summary
public static final QName NAME Name of this declaration.

optionalProperty	back to summary
private OptionalPropertyMode optionalProperty Annotations @XmlAttribute

BIProperty	back to summary
public BIProperty(Locator loc, String _propName, String _javadoc, BIProperty.BaseTypeBean _baseType, CollectionTypeAttribute collectionType, Boolean isConst, OptionalPropertyMode optionalProperty, Boolean genElemProp)

BIProperty	back to summary
protected BIProperty()

Method Detail

concat	back to summary
private static String concat(String s1, String s2)

constantPropertyErrorCheck	back to summary
private void constantPropertyErrorCheck()

createAttributeProperty	back to summary
public CAttributePropertyInfo createAttributeProperty(XSAttributeUse use, TypeUse tu)

createContentExtendedMixedReferenceProperty	back to summary
public CReferencePropertyInfo createContentExtendedMixedReferenceProperty(String defaultName, XSComponent source, RawTypeSet types)

createDummyExtendedMixedReferenceProperty	back to summary
public CReferencePropertyInfo createDummyExtendedMixedReferenceProperty(String defaultName, XSComponent source, RawTypeSet types)

createElementOrReferenceProperty	back to summary
public CPropertyInfo createElementOrReferenceProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types)

createElementProperty	back to summary
public CElementPropertyInfo createElementProperty(String defaultName, boolean forConstant, XSParticle source, RawTypeSet types) Parameters defaultName:String 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:XSParticle Source schema component from which a field is built.

createReferenceProperty	back to summary
public CReferencePropertyInfo createReferenceProperty(String defaultName, boolean forConstant, XSComponent source, RawTypeSet types, boolean isMixed, boolean dummy, boolean content, boolean isMixedExtended)

createValueProperty	back to summary
public CValuePropertyInfo createValueProperty(String defaultName, boolean forConstant, XSComponent source, TypeUse tu, QName typeName)

generateElementProperty	back to summary
private Boolean generateElementProperty() If true, the property will automatically be a reference property. (Talk about confusing names!)

getBaseType	back to summary
public JType getBaseType()

getChildren	back to summary
public Collection<BIDeclaration> getChildren() Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.getChildren. Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getChildren. Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getChildren. Gets child s if any. Annotations @Override

getChildren

back to summary

public Collection<BIDeclaration> getChildren()

Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.getChildren.

Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getChildren.

Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getChildren.

Gets child s if any.

Annotations

@Override

getCollectionType	back to summary
pack-priv CollectionTypeAttribute getCollectionType() Gets the realization of this field. Returns:CollectionTypeAttribute Always return non-null.

getCollectionType

back to summary

pack-priv CollectionTypeAttribute getCollectionType()

Gets the realization of this field.

Returns:CollectionTypeAttribute: Always return non-null.

getConv	back to summary
public BIConversion getConv()

getCustomization	back to summary
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. 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:XSComponent A customization effective on this component will be returned. Can be null just to get the global customization. Returns:BIProperty Always return non-null valid object.

getCustomization

back to summary

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. 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:XSComponent: A customization effective on this component will be returned. Can be null just to get the global customization.

Returns:BIProperty

Always return non-null valid object.

getCustomizations	back to summary
private CCustomizations getCustomizations(XSComponent src)

getCustomizations	back to summary
private CCustomizations getCustomizations(XSComponent... src)

getCustomizations	back to summary
private CCustomizations getCustomizations(XSAttributeUse src)

getCustomizations	back to summary
private CCustomizations getCustomizations(XSParticle src)

getDefault	back to summary
protected BIProperty getDefault() Finds a BIProperty which this object should delegate to. Returns:BIProperty always return non-null for normal BIProperties. If this object is contained in the BIGlobalBinding, then this method returns null to indicate that there's no more default.

getDefault

back to summary

protected BIProperty getDefault()

Finds a BIProperty which this object should delegate to.

Returns:BIProperty: always return non-null for normal BIProperties. If this object is contained in the BIGlobalBinding, then this method returns null to indicate that there's no more default.

getDefault	back to summary
private static BIProperty getDefault(BGMBuilder builder, XSComponent c)

getJavadoc	back to summary
public String getJavadoc() Gets the associated javadoc. Returns:String null if none is specfieid.

getJavadoc

back to summary

public String getJavadoc()

Gets the associated javadoc.

Returns:String: null if none is specfieid.

getName	back to summary
public QName getName() Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getName. Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getName. Gets the name of this binding declaration, which is the same as the tag name of the binding element. Annotations @Override

getName

back to summary

public QName getName()

Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getName.

Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.getName.

Gets the name of this binding declaration, which is the same as the tag name of the binding element.

Annotations

@Override

getOptionalPropertyMode	back to summary
public OptionalPropertyMode getOptionalPropertyMode()

getPropertyName	back to summary
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:boolean If the property name is intended for a constant property name, set to true. This will change the result Returns:String This method can return null if the customization doesn't specify the name.

getPropertyName

back to summary

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:boolean: If the property name is intended for a constant property name, set to true. This will change the result

Returns:String

This method can return null if the customization doesn't specify the name.

isConstantProperty	back to summary
public boolean isConstantProperty() 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.

isConstantProperty

back to summary

public boolean isConstantProperty()

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	back to summary
public void markAsAcknowledged() Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.markAsAcknowledged. Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.markAsAcknowledged. Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.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.) Declarations that are not acknowledged will be considered as an error. Annotations @Override

markAsAcknowledged

back to summary

public void markAsAcknowledged()

Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.markAsAcknowledged.

Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.markAsAcknowledged.

Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.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.)

Declarations that are not acknowledged will be considered as an error.

Annotations

@Override

setGenerateIsSetMethod	back to summary
pack-priv void setGenerateIsSetMethod(boolean b) Annotations @XmlAttribute

setParent back to summary

setParent	back to summary
public void setParent(BindInfo parent) Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.setParent. Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.setParent. Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.setParent. Sets the parent BindInfo object of this declaration. A declaration object can use this pointer to access context information, such as other customizations. 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 . Annotations @Override

public void setParent(BindInfo parent)

Overrides com.sun.tools.xjc.reader.xmlschema.bindinfo.AbstractDeclarationImpl.setParent.

Implements com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.setParent.

Doc from com.sun.tools.xjc.reader.xmlschema.bindinfo.BIDeclaration.setParent.

Sets the parent BindInfo object of this declaration. A declaration object can use this pointer to access context information, such as other customizations.

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 .

Annotations

@Override

wrapUp	back to summary
private <T extends CPropertyInfo> T wrapUp(T prop, XSComponent source) Common finalization of `CPropertyInfo` for the create***Property methods.

Modifier and Type	Field and Description
pack-priv BIConversion	conv If there's a nested javaType customization, this field will keep that customization.
pack-priv String	name Java type name.

public final Class BIProperty

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BIProperty.BaseTypeBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail