Top Description Fields Constructors Methods
com.ctc.wstx.dtd

public final Class DTDId

extends Object
Class Inheritance
Imports
java.net.URI
Simple key object class, used for accessing (external) DTDs when stored for caching. Main idea is that the primary id of a DTD (public or system id; latter normalized if possible) has to match, as well as couple of on/off settings for parsing (namespace support, text normalization). Latter restriction is needed since although DTDs do not deal with (or understand) namespaces, some parsing is done to be able to validate namespace aware/non-aware documents, and handling differs between the two. As to primary key part, public id is used if one was defined; if so, comparison is String equality. If not, then system id is compared: system id has to be expressed as URL if so.

Field Summary

Modifier and TypeField and Description
protected final int
mConfigFlags

protected int
mHashCode

protected final String
mPublicId

protected final URI
mSystemId

protected final boolean
mXml11

Constructor Summary

AccessConstructor and Description
private
DTDId(String publicId, URI systemId, int configFlags, boolean xml11)

Method Summary

Modifier and TypeMethod and Description
public static DTDId
construct(String publicId, URI systemId, int configFlags, boolean xml11)

public static DTDId
constructFromPublicId(String publicId, int configFlags, boolean xml11)

public static DTDId
constructFromSystemId(URI systemId, int configFlags, boolean xml11)

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

mConfigFlagsback to summary
protected final int mConfigFlags
mHashCodeback to summary
protected int mHashCode
mPublicIdback to summary
protected final String mPublicId
mSystemIdback to summary
protected final URI mSystemId
mXml11back to summary
protected final boolean mXml11

Constructor Detail

DTDIdback to summary
private DTDId(String publicId, URI systemId, int configFlags, boolean xml11)

Method Detail

constructback to summary
public static DTDId construct(String publicId, URI systemId, int configFlags, boolean xml11)
constructFromPublicIdback to summary
public static DTDId constructFromPublicId(String publicId, int configFlags, boolean xml11)
constructFromSystemIdback to summary
public static DTDId constructFromSystemId(URI systemId, int configFlags, boolean xml11)
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.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
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.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override