Package org.deckfour.xes.id

Class XID

  • All Implemented Interfaces:
    java.lang.Cloneable, java.lang.Comparable<XID>
    public class XID
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<XID>
    Implements a unique ID based on UUID.
    Author:
    Christian W. Guenther (christian@deckfour.org)

    • Constructor Summary

      Constructors 
      Constructor Description
      XID()
      Creates a new XID object.
      XID​(long msb, long lsb)
      Creates a new XID object.
      XID​(java.util.UUID uuid)
      Creates a new XID object.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Creates a clone of this ID.
      int compareTo​(XID o)  
      boolean equals​(java.lang.Object obj)
      Tests XID object for equality.
      int hashCode()
      Returns a hash code for this XID.
      static XID parse​(java.lang.String idString)
      Parses an XID object from its text representation.
      static XID read​(java.io.DataInput in)
      Reads a binary-serialized XID from a data input.
      static XID read​(java.io.DataInputStream dis)
      Reads a binary-serialized XID from a data input stream.
      java.lang.String toString()
      Returns the string representation of an XID instance.
      static void write​(XID id, java.io.DataOutput out)
      Serializes an XID object binarily to a data output stream.
      static void write​(XID id, java.io.DataOutputStream dos)
      Serializes an XID object binarily to a data output stream.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • XID

        public XID()
        Creates a new XID object.

      • XID

        public XID​(long msb,
           long lsb)
        Creates a new XID object.
        Parameters:
        msb - Most significant bits of an UUID
        lsb - Least significant bits of an UUID

      • XID

        public XID​(java.util.UUID uuid)
        Creates a new XID object.
        Parameters:
        uuid - The UUID implementing XID uniqueness.

    • Method Detail

      • parse

        public static XID parse​(java.lang.String idString)
        Parses an XID object from its text representation.
        Parameters:
        idString - Text representation of an XID.
        Returns:
        The parsed XID.

      • read

        public static XID read​(java.io.DataInputStream dis)
                throws java.io.IOException
        Reads a binary-serialized XID from a data input stream.
        Parameters:
        dis - Data input stream to read XID from.
        Returns:
        The read XID object.
        Throws:
        java.io.IOException

      • read

        public static XID read​(java.io.DataInput in)
                throws java.io.IOException
        Reads a binary-serialized XID from a data input.
        Parameters:
        in - Data input to read XID from.
        Returns:
        The read XID object.
        Throws:
        java.io.IOException

      • write

        public static void write​(XID id,
                         java.io.DataOutputStream dos)
                  throws java.io.IOException
        Serializes an XID object binarily to a data output stream.
        Parameters:
        id - XID to be serialized.
        dos - Data output stream to store XID serialization.
        Throws:
        java.io.IOException

      • write

        public static void write​(XID id,
                         java.io.DataOutput out)
                  throws java.io.IOException
        Serializes an XID object binarily to a data output stream.
        Parameters:
        id - XID to be serialized.
        out - Data output to store XID serialization.
        Throws:
        java.io.IOException

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests XID object for equality.
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Returns the string representation of an XID instance.
        Overrides:
        toString in class java.lang.Object

      • clone

        public java.lang.Object clone()
        Creates a clone of this ID.
        Overrides:
        clone in class java.lang.Object

      • hashCode

        public int hashCode()
        Returns a hash code for this XID.
        Overrides:
        hashCode in class java.lang.Object

      • compareTo

        public int compareTo​(XID o)
        Specified by:
        compareTo in interface java.lang.Comparable<XID>