Top Description Inners Fields Constructors Methods
com.sun.tools.xjc.reader.xmlschema.bindinfo

public final Class BindInfo

extends Object
implements Iterable<BIDeclaration>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Annotations
@XmlRootElement
namespace:http://www.w3.org/2001/XMLSchema
name:annotation
@XmlType
namespace:http://www.w3.org/2001/XMLSchema
name:foobar
Imports
java.io.FilterWriter, .IOException, .StringWriter, .Writer, java.util.ArrayList, .Iterator, .List, jakarta.xml.bind.JAXBContext, .JAXBException, .Unmarshaller, jakarta.xml.bind.annotation.XmlAnyElement, .XmlElement, .XmlMixed, .XmlRootElement, .XmlType, javax.xml.XMLConstants, javax.xml.transform.Transformer, .TransformerException, javax.xml.transform.dom.DOMSource, javax.xml.transform.stream.StreamResult, com.sun.codemodel.JDocComment, com.sun.tools.xjc.SchemaCache, com.sun.tools.xjc.model.CCustomizations, .CPluginCustomization, .Model, com.sun.tools.xjc.reader.Ring, com.sun.tools.xjc.reader.xmlschema.BGMBuilder, org.glassfish.jaxb.core.annotation.XmlLocation, org.glassfish.jaxb.core.marshaller.MinimumEscapeHandler, com.sun.xml.xsom.XSComponent, org.w3c.dom.Element, org.xml.sax.Locator
Container for customization declarations. We use JAXB ourselves and parse this object from "xs:annotation".
Author
Kohsuke Kawaguchi (kohsuke,[email protected])

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
BindInfo.AppInfo

private static class
BindInfo.Documentation

Field Summary

Modifier and TypeField and Description
public static final SchemaCache
bindingFileSchema

Lazily parsed schema for the binding file.

private BGMBuilder
builder

private static volatile JAXBContext
customizationContext

Lazily prepared JAXBContext.

private final List<BIDeclaration>
decls

list of individual declarations.

private BindInfo.Documentation
documentation

Documentation taken from <xs:documentation>s.

public static final BindInfo
empty

An instance with the empty contents.

private Locator
location

private XSComponent
owner

Constructor Summary

AccessConstructor and Description
public
BindInfo()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public void
absorb(BindInfo bi)

Merges all the declarations inside the given BindInfo to this BindInfo.

public void
addDecl(BIDeclaration decl)

Adds a new declaration.

public <T extends BIDeclaration> T
get(Class<T> kind)

Gets the first declaration with a given name, or null if none is found.

public BIDeclaration
get(int idx)

public BGMBuilder
getBuilder()

Back pointer to the BGMBuilder which is building a BGM from schema components including this customization.

public static JAXBContext
getCustomizationContext()

public static Unmarshaller
getCustomizationUnmarshaller()

public BIDeclaration[]
getDecls()

Gets all the declarations

public String

Returns:

maybe null.
getDocumentation()

Gets the documentation parsed from <xs:documentation>s.

public XSComponent
getOwner()

public Locator

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.
getSourceLocation()

Gets the location of this annotation in the source file.

public boolean
isPointless()

Returns true if this doesn't contain any useful information.

public Iterator<BIDeclaration>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

pack-priv void
setAppinfo(BindInfo.AppInfo aib)

public void
setOwner(BGMBuilder _builder, XSComponent _owner)

Sets the owner schema component and a reference to BGMBuilder.

public int
size()

Gets the number of declarations.

public CCustomizations
toCustomizationList()

Gets the list of CPluginCustomizations from this.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bindingFileSchemaback to summary
public static final SchemaCache bindingFileSchema

Lazily parsed schema for the binding file.

builderback to summary
private BGMBuilder builder
customizationContextback to summary
private static volatile JAXBContext customizationContext

Lazily prepared JAXBContext.

declsback to summary
private final List<BIDeclaration> decls

list of individual declarations.

documentationback to summary
private BindInfo.Documentation documentation

Documentation taken from <xs:documentation>s.

Annotations
@XmlElement
namespace:http://www.w3.org/2001/XMLSchema
emptyback to summary
public static final BindInfo empty

An instance with the empty contents.

locationback to summary
private Locator location
Annotations
@XmlLocation
ownerback to summary
private XSComponent owner

Constructor Detail

BindInfoback to summary
public BindInfo()

Default constructor.

Method Detail

absorbback to summary
public void absorb(BindInfo bi)

Merges all the declarations inside the given BindInfo to this BindInfo.

addDeclback to summary
public void addDecl(BIDeclaration decl)

Adds a new declaration.

getback to summary
public <T extends BIDeclaration> T get(Class<T> kind)

Gets the first declaration with a given name, or null if none is found.

getback to summary
public BIDeclaration get(int idx)
getBuilderback to summary
public BGMBuilder getBuilder()

Back pointer to the BGMBuilder which is building a BGM from schema components including this customization.

getCustomizationContextback to summary
public static JAXBContext getCustomizationContext()
getCustomizationUnmarshallerback to summary
public static Unmarshaller getCustomizationUnmarshaller()
getDeclsback to summary
public BIDeclaration[] getDecls()

Gets all the declarations

getDocumentationback to summary
public String getDocumentation()

Gets the documentation parsed from <xs:documentation>s. The returned collection is to be added to JDocComment#append(Object).

Returns:String

maybe null.

getOwnerback to summary
public XSComponent getOwner()
getSourceLocationback to summary
public Locator getSourceLocation()

Gets the location of this annotation in the source file.

Returns:Locator

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.

isPointlessback to summary
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.

iteratorback to summary
public Iterator<BIDeclaration> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations
@Override
setAppinfoback to summary
pack-priv void setAppinfo(BindInfo.AppInfo aib)
Annotations
@XmlElement
namespace:http://www.w3.org/2001/XMLSchema
setOwnerback to summary
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.

sizeback to summary
public int size()

Gets the number of declarations.

toCustomizationListback to summary
public CCustomizations toCustomizationList()

Gets the list of CPluginCustomizations from this.

Note that calling this method marks all those plug-in customizations as 'used'. So call it only when it's really necessary.

com.sun.tools.xjc.reader.xmlschema.bindinfo back to summary

private final Class BindInfo.AppInfo

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv List<Object>
contents

Receives BIDeclarations and other DOMs.

Constructor Summary

AccessConstructor and Description
private
AppInfo()

Method Summary

Modifier and TypeMethod and Description
public void
addTo(BindInfo bi)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

contentsback to summary
pack-priv List<Object> contents

Receives BIDeclarations and other DOMs.

Annotations
@XmlAnyElement:DomHandlerEx
lax:true

Constructor Detail

AppInfoback to summary
private AppInfo()

Method Detail

addToback to summary
public void addTo(BindInfo bi)
com.sun.tools.xjc.reader.xmlschema.bindinfo back to summary

private final Class BindInfo.Documentation

extends Object
Class Inheritance
  • java.lang.Object
  • com.sun.tools.xjc.reader.xmlschema.bindinfo.BindInfo.Documentation

Field Summary

Modifier and TypeField and Description
pack-priv List<Object>
contents

Constructor Summary

AccessConstructor and Description
private
Documentation()

Method Summary

Modifier and TypeMethod and Description
pack-priv void
addAll(BindInfo.Documentation rhs)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

contentsback to summary
pack-priv List<Object> contents
Annotations
@XmlAnyElement
@XmlMixed

Constructor Detail

Documentationback to summary
private Documentation()

Method Detail

addAllback to summary
pack-priv void addAll(BindInfo.Documentation rhs)