Class SimpleACIArea.Chop

java.lang.Object
com.isode.dsapi.aci.SimpleACIArea.Chop
All Implemented Interfaces:
Comparable<SimpleACIArea.Chop>
Enclosing class:
SimpleACIArea

public static class SimpleACIArea.Chop extends Object implements Comparable<SimpleACIArea.Chop>
Chop-point within a Region. This is an immutable object.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final boolean
    Chop before ('false'), or chop after ('true')
    final DN
    Chop DN.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Chop(DN dn, boolean after)
    Construct a chop point.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Comparison, ordered by DN then before/after.
    void
    dumpXML(com.isode.util.XMLOutput out)
    Dump the chop-point out to the given XMLOutput stream.
    boolean
    Equality test.
    int
    Hash code.
    loadXML(com.isode.util.XMLInput in)
    Try to load up a Chop from XML.
    relocate(DN source, DN target)
    Relocate a chop-point, or return 'this' if the chop is unaffected by the relocation.
    Return debug string.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • dn

      public final DN dn
      Chop DN.
    • after

      public final boolean after
      Chop before ('false'), or chop after ('true')
  • Constructor Details

    • Chop

      public Chop(DN dn, boolean after)
      Construct a chop point.
  • Method Details

    • relocate

      public SimpleACIArea.Chop relocate(DN source, DN target)
      Relocate a chop-point, or return 'this' if the chop is unaffected by the relocation.
    • dumpXML

      public void dumpXML(com.isode.util.XMLOutput out) throws IOException
      Dump the chop-point out to the given XMLOutput stream.
      Throws:
      IOException
    • loadXML

      public static SimpleACIArea.Chop loadXML(com.isode.util.XMLInput in)
      Try to load up a Chop from XML. If not present or invalid, null is returned.
    • toString

      public String toString()
      Return debug string.
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Hash code.
      Overrides:
      hashCode in class Object
    • compareTo

      public int compareTo(SimpleACIArea.Chop bb)
      Comparison, ordered by DN then before/after.
      Specified by:
      compareTo in interface Comparable<SimpleACIArea.Chop>
    • equals

      public boolean equals(Object oo)
      Equality test.
      Overrides:
      equals in class Object