Class TSRefC

java.lang.Object
  extended by TSRefC
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TSRefC>

 class TSRefC
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<TSRefC>

.

======================================================================
 Class TSRefC -- Definition of a 'Reference-Control'-class
   This class controls references, which uses either numbers or
   addresses or both to connect class-entries together.
   It also contains a (second) independant ID-Number, so that these
   entries may be sorted.
   This number may also be used as an 'aditional information'.

  Attention: This class may also be used for other reasons and
             therefore may not reference a single object. However,
             this is stated in the super-class if appropriate.
 ##TSRefC (Eyecatcher)
======================================================================
 


Field Summary
private  java.lang.Object Adr
           
protected static java.lang.String IdStr
           
private  int Ix
           
private  int Nr
           
 
Constructor Summary
protected TSRefC()
          .
protected TSRefC(int c)
          .
protected TSRefC(int c, java.lang.Object o)
          .
protected TSRefC(TSRefC cRef)
          .
 
Method Summary
protected  int addNr(int inc)
          .
protected  int chgIx(int ix)
          .
protected  int chgNr(int nr)
          .
protected  java.lang.Object chgRef(java.lang.Object o)
          .
protected  int cmpNr(TSRefC vR)
          .
 int compareTo(TSRefC vR)
          .
protected  java.lang.String toStr()
          .
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IdStr

protected static final java.lang.String IdStr
See Also:
Constant Field Values

Ix

private int Ix

Nr

private int Nr

Adr

private java.lang.Object Adr
Constructor Detail

TSRefC

protected TSRefC()
.
=====================================================================
 Constructor: (1) create default-entry
=====================================================================
  


TSRefC

protected TSRefC(int c)
.
=====================================================================
 Constructor: (2) create standard-entry
=====================================================================
  


TSRefC

protected TSRefC(int c,
                 java.lang.Object o)
.
=====================================================================
 Constructor: (3) Create complete entry
=====================================================================
  


TSRefC

protected TSRefC(TSRefC cRef)
.
=====================================================================
 Constructor: (4) Create copy-entry from template.
 Attention: The referenced object is NOT copied. ONLY the reference
          is transfered to the new TSRefC-object.
=====================================================================
  

Method Detail

addNr

protected final int addNr(int inc)
.
=====================================================================
 Method "addNr"
 Increment or Decrement reference-value (number).
 Attention: if this method is used, ONLY positive numbers are
            supported, range is also checked.
 This method return the result of the operation.
 ##addNr.TSRefC (Eyecatcher)
=====================================================================
  


chgIx

protected final int chgIx(int ix)
.
=====================================================================
 Method "chgIx"
 Get/update index of entry (aditional information).
 Attention: positive AND negative numbers are supported.
 ##chgIx.TSRefC (Eyecatcher)
=====================================================================
  


chgNr

protected final int chgNr(int nr)
.
=====================================================================
 Method "chgNr"
 Modify or return reference-value (number).
 Attention: positive AND negative numbers are supported.
 ##chgNr.TSRefC (Eyecatcher)
=====================================================================
  


chgRef

protected final java.lang.Object chgRef(java.lang.Object o)
.
=====================================================================
 Method "chgRef"
 Modify or return address-reference-value.
 ##chgRef.TSRefC (Eyecatcher)
=====================================================================
  


compareTo

public final int compareTo(TSRefC vR)
.
=====================================================================
 Method "compareTo"
 Method is used to sort Elements.
 Attention: Name of this Methode is requested by Interface
           'Comparable'. Results need NOT be 0,1,-1 .
 Note: This class has a natural ordering that is
       inconsistent with equals.
 ##compareTo.TSRefC (Eyecatcher)
=====================================================================
  

Specified by:
compareTo in interface java.lang.Comparable<TSRefC>

cmpNr

protected final int cmpNr(TSRefC vR)
.
=====================================================================
 Method "cmpNr"
 Compare reference-entries using 'NR'-definition.
 ##cmpNr.TSRefC (Eyecatcher)
=====================================================================
  


toStr

protected final java.lang.String toStr()
.
=====================================================================
 Method "toStr"
 Build a string-representation of all values of this class.
 ##toStr.TSRefC (Eyecatcher)
=====================================================================