Top Description Fields Constructors Methods
com.sun.xml.xsom.impl.parser

public final Class SchemaDocumentImpl

extends Object
implements SchemaDocument
Class Inheritance
All Implemented Interfaces
com.sun.xml.xsom.parser.SchemaDocument
Imports
com.sun.xml.xsom.impl.SchemaImpl, com.sun.xml.xsom.parser.SchemaDocument, java.util.Collections, .HashSet, .Set

SchemaDocument implementation.
Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
pack-priv final Set<SchemaDocumentImpl>
references

SchemaDocumentImpls that are referenced from this document.

pack-priv final Set<SchemaDocumentImpl>
referers

SchemaDocumentImpls that are referencing this document.

private final SchemaImpl
private final String
schemaDocumentURI

URI of the schema document to be parsed.

Constructor Summary

AccessConstructor and Description
protected
SchemaDocumentImpl(SchemaImpl schema, String _schemaDocumentURI)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Set<SchemaDocument>
getImportedDocuments(String targetNamespace)

Implements com.sun.xml.xsom.parser.SchemaDocument.getImportedDocuments.

Gets the s that are imported from this document.

public Set<SchemaDocument>
getIncludedDocuments()

Implements com.sun.xml.xsom.parser.SchemaDocument.getIncludedDocuments.

Gets the s that are included from this document.

public Set<SchemaDocument>
getReferencedDocuments()

Implements com.sun.xml.xsom.parser.SchemaDocument.getReferencedDocuments.

Set of s that are included/imported from this document.

public Set<SchemaDocument>
getReferers()

Implements com.sun.xml.xsom.parser.SchemaDocument.getReferers.

Set of s that include/import this document.

public SchemaImpl
getSchema()

Implements com.sun.xml.xsom.parser.SchemaDocument.getSchema.

Gets XSSchema component that contains all the schema components defined in this namespace.

public String
getSystemId()

Implements com.sun.xml.xsom.parser.SchemaDocument.getSystemId.

Gets the system ID of the schema document.

public String
getTargetNamespace()

Implements com.sun.xml.xsom.parser.SchemaDocument.getTargetNamespace.

The namespace that this schema defines.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
imports(SchemaDocument doc)

Implements com.sun.xml.xsom.parser.SchemaDocument.imports.

Returns true if this document imports the given document.

public boolean
includes(SchemaDocument doc)

Implements com.sun.xml.xsom.parser.SchemaDocument.includes.

Returns true if this document includes the given document.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

referencesback to summary
pack-priv final Set<SchemaDocumentImpl> references

SchemaDocumentImpls that are referenced from this document.

referersback to summary
pack-priv final Set<SchemaDocumentImpl> referers

SchemaDocumentImpls that are referencing this document.

schemaback to summary
private final SchemaImpl schema
schemaDocumentURIback to summary
private final String schemaDocumentURI

URI of the schema document to be parsed. Can be null.

Constructor Detail

SchemaDocumentImplback to summary
protected SchemaDocumentImpl(SchemaImpl schema, String _schemaDocumentURI)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getImportedDocumentsback to summary
public Set<SchemaDocument> getImportedDocuments(String targetNamespace)

Implements com.sun.xml.xsom.parser.SchemaDocument.getImportedDocuments.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getImportedDocuments.

Gets the s that are imported from this document.

getIncludedDocumentsback to summary
public Set<SchemaDocument> getIncludedDocuments()

Implements com.sun.xml.xsom.parser.SchemaDocument.getIncludedDocuments.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getIncludedDocuments.

Gets the s that are included from this document.

getReferencedDocumentsback to summary
public Set<SchemaDocument> getReferencedDocuments()

Implements com.sun.xml.xsom.parser.SchemaDocument.getReferencedDocuments.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getReferencedDocuments.

Set of s that are included/imported from this document.

getReferersback to summary
public Set<SchemaDocument> getReferers()

Implements com.sun.xml.xsom.parser.SchemaDocument.getReferers.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getReferers.

Set of s that include/import this document.

This works as the opposite of getReferencedDocuments().

getSchemaback to summary
public SchemaImpl getSchema()

Implements com.sun.xml.xsom.parser.SchemaDocument.getSchema.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getSchema.

Gets XSSchema component that contains all the schema components defined in this namespace.

The returned XSSchema contains not just components defined in this but all the other components defined in all the schemas that collectively define this namespace.

getSystemIdback to summary
public String getSystemId()

Implements com.sun.xml.xsom.parser.SchemaDocument.getSystemId.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getSystemId.

Gets the system ID of the schema document.

getTargetNamespaceback to summary
public String getTargetNamespace()

Implements com.sun.xml.xsom.parser.SchemaDocument.getTargetNamespace.

Doc from com.sun.xml.xsom.parser.SchemaDocument.getTargetNamespace.

The namespace that this schema defines.

More precisely, this method simply returns the targetNamespace attribute of the schema document. When schemas are referenced in certain ways (AKA chameleon schema), schema components in this schema document may end up defining components in other namespaces.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
importsback to summary
public boolean imports(SchemaDocument doc)

Implements com.sun.xml.xsom.parser.SchemaDocument.imports.

Doc from com.sun.xml.xsom.parser.SchemaDocument.imports.

Returns true if this document imports the given document.

Note that this method returns false if this document includes the given document.

includesback to summary
public boolean includes(SchemaDocument doc)

Implements com.sun.xml.xsom.parser.SchemaDocument.includes.

Doc from com.sun.xml.xsom.parser.SchemaDocument.includes.

Returns true if this document includes the given document.

Note that this method returns false if this document imports the given document.