- java.lang.Object
-
- com.sun.tools.xjc.reader.xmlschema.bindinfo.BindInfo
-
- All Implemented Interfaces:
Iterable<BIDeclaration>
public final class BindInfo extends Object implements Iterable<BIDeclaration>
Container for customization declarations. We use JAXB ourselves and parse this object from "xs:annotation".- Author:
- Kohsuke Kawaguchi (kohsuke,[email protected])
-
-
Field Summary
Fields Modifier and Type Field Description static SchemaCache
bindingFileSchema
Lazily parsed schema for the binding file.static BindInfo
empty
An instance with the empty contents.
-
Constructor Summary
Constructors Constructor Description BindInfo()
Default constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
absorb(BindInfo bi)
Merges all the declarations inside the given BindInfo to this BindInfo.void
addDecl(BIDeclaration decl)
Adds a new declaration.BIDeclaration
get(int idx)
<T extends BIDeclaration>
Tget(Class<T> kind)
Gets the first declaration with a given name, or null if none is found.BGMBuilder
getBuilder()
Back pointer to the BGMBuilder which is building a BGM from schema components including this customization.static jakarta.xml.bind.JAXBContext
getCustomizationContext()
static jakarta.xml.bind.Unmarshaller
getCustomizationUnmarshaller()
BIDeclaration[]
getDecls()
Gets all the declarationsString
getDocumentation()
Gets the documentation parsed from<xs:documentation>
s.XSComponent
getOwner()
Locator
getSourceLocation()
Gets the location of this annotation in the source file.boolean
isPointless()
Returns true if this doesn't contain any useful information.Iterator<BIDeclaration>
iterator()
void
setOwner(BGMBuilder _builder, XSComponent _owner)
Sets the owner schema component and a reference to BGMBuilder.int
size()
Gets the number of declarations.CCustomizations
toCustomizationList()
Gets the list ofCPluginCustomization
s from this.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Field Detail
-
empty
public static final BindInfo empty
An instance with the empty contents.
-
bindingFileSchema
public static final SchemaCache bindingFileSchema
Lazily parsed schema for the binding file.
-
-
Method Detail
-
isPointless
public boolean isPointless()
Returns true if this doesn't contain any useful information. This flag is used to discard unused s early to save memory footprint.
-
getSourceLocation
public Locator getSourceLocation()
Gets the location of this annotation in the source file.- Returns:
- If the declarations are in fact specified in the source code, a non-null valid object will be returned. If this BindInfo is generated internally by XJC, then null will be returned.
-
setOwner
public void setOwner(BGMBuilder _builder, XSComponent _owner)
Sets the owner schema component and a reference to BGMBuilder. This method is called from the BGMBuilder before any BIDeclaration inside it is used.
-
getOwner
public XSComponent getOwner()
-
getBuilder
public BGMBuilder getBuilder()
Back pointer to the BGMBuilder which is building a BGM from schema components including this customization.
-
addDecl
public void addDecl(BIDeclaration decl)
Adds a new declaration.
-
get
public <T extends BIDeclaration> T get(Class<T> kind)
Gets the first declaration with a given name, or null if none is found.
-
getDecls
public BIDeclaration[] getDecls()
Gets all the declarations
-
getDocumentation
public String getDocumentation()
Gets the documentation parsed from<xs:documentation>
s. The returned collection is to be added toJDocComment.append(Object)
.- Returns:
- maybe null.
-
absorb
public void absorb(BindInfo bi)
Merges all the declarations inside the given BindInfo to this BindInfo.
-
size
public int size()
Gets the number of declarations.
-
get
public BIDeclaration get(int idx)
-
iterator
public Iterator<BIDeclaration> iterator()
- Specified by:
iterator
in interfaceIterable<BIDeclaration>
-
toCustomizationList
public CCustomizations toCustomizationList()
Gets the list ofCPluginCustomization
s from this.Note that calling this method marks all those plug-in customizations as 'used'. So call it only when it's really necessary.
-
getCustomizationContext
public static jakarta.xml.bind.JAXBContext getCustomizationContext()
-
getCustomizationUnmarshaller
public static jakarta.xml.bind.Unmarshaller getCustomizationUnmarshaller()
-
-