Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.txt2xml.core
Class SubCharSequence  view SubCharSequence download SubCharSequence.java

java.lang.Object
  extended byorg.txt2xml.core.SubCharSequence
All Implemented Interfaces:
java.lang.CharSequence

public final class SubCharSequence
extends java.lang.Object
implements java.lang.CharSequence

For internal use. A CharSequence that represents a sub-sequence of some parent java.lang.CharSequence.


Field Summary
private  int length
           
private  int offset
           
private  java.lang.CharSequence parent
           
 
Constructor Summary
SubCharSequence(java.lang.CharSequence parent, int offset, int length)
           
 
Method Summary
 char charAt(int index)
          Returns the character at the given index.
 boolean equals(java.lang.Object obj)
          Determine whether this Object is semantically equal to another Object.
 int getOffset()
           
 int length()
          Returns the length of the sequence.
 java.lang.CharSequence subSequence(int start, int end)
          Returns a new CharSequence of the indicated range.
 java.lang.String toString()
          Returns the complete CharSequence as a String.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

parent

private java.lang.CharSequence parent

offset

private int offset

length

private int length
Constructor Detail

SubCharSequence

public SubCharSequence(java.lang.CharSequence parent,
                       int offset,
                       int length)
Method Detail

getOffset

public int getOffset()

length

public int length()
Description copied from interface: java.lang.CharSequence
Returns the length of the sequence. This is the number of 16-bit characters in the sequence, which may differ from the length of the underlying encoding.

Specified by:
length in interface java.lang.CharSequence

charAt

public char charAt(int index)
Description copied from interface: java.lang.CharSequence
Returns the character at the given index.

Specified by:
charAt in interface java.lang.CharSequence

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)
Description copied from interface: java.lang.CharSequence
Returns a new CharSequence of the indicated range.

Specified by:
subSequence in interface java.lang.CharSequence

toString

public java.lang.String toString()
Description copied from interface: java.lang.CharSequence
Returns the complete CharSequence as a String. Classes that implement this interface should return a String which contains only the characters in the sequence in the correct order.

Specified by:
toString in interface java.lang.CharSequence

equals

public boolean equals(java.lang.Object obj)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.