dojox/uuid/Uuid.js

• Provides:

  • dojox.uuid.Uuid

• Requires:

  • dojox.uuid in common

• dojox.uuid.Uuid

  • parameters:
    • input: (typeof String)

      A 36-character string that conforms to the UUID spec.
      examples:
      var uuid;
      uuid = new dojox.uuid.Uuid("3b12f1df-5232-4804-897e-917bf397618a");
      uuid = new dojox.uuid.Uuid(); // "00000000-0000-0000-0000-000000000000"
      uuid = new dojox.uuid.Uuid(dojox.uuid.generateRandomUuid());
      uuid = new dojox.uuid.Uuid(dojox.uuid.generateTimeBasedUuid());
      dojox.uuid.Uuid.setGenerator(dojox.uuid.generateRandomUuid);
      uuid = new dojox.uuid.Uuid();
      dojox.uuid.assert(!uuid.isEqual(dojox.uuid.NIL_UUID));

  • summary

    This is the constructor for the Uuid class.  The Uuid class offers
    methods for inspecting existing UUIDs.

  • type

    Function

• dojox.uuid.Uuid._uuidString

  • type

    Object

• dojox.uuid.Uuid.compare

  • parameters:
    • uuidOne: (typeof dojox.uuid.Uuid)

      Any object that has toString() method that returns a 36-character string that conforms to the UUID spec.

    • uuidTwo: (typeof dojox.uuid.Uuid)

      Any object that has toString() method that returns a 36-character string that conforms to the UUID spec.

    • otherUuid: (typeof dojox.uuid.Uuid)

      Any object that has toString() method that returns a 36-character string that conforms to the UUID spec.

  • returns

    integer|integer (either 0, 1, or -1)

  • summary

    Compares this UUID to another UUID, and returns 0, 1, or -1.

  • description

    This implementation is intended to match the sample implementation
    in IETF RFC 4122: http://www.ietf.org/rfc/rfc4122.txt

  • type

    Function

• dojox.uuid.Uuid.setGenerator

  • parameters:
    • generator: (typeof Function)

      A UUID generator function, such as dojox.uuid.generateTimeBasedUuid.

  • summary

    Sets the default generator, which will be used by the
    "new dojox.uuid.Uuid()" constructor if no parameters
    are passed in.

  • type

    Function

• dojox.uuid.Uuid._ourGenerator

  • alias - generator

• dojox.uuid.Uuid.getGenerator

  • returns

    generator (A UUID generator, such as dojox.uuid.TimeBasedGenerator).

  • summary

    Returns the default generator.  See setGenerator().

  • type

    Function

• dojox.uuid.Uuid.toString

  • returns

    string

  • summary

    This method returns a standard 36-character string representing
    the UUID, such as "3b12f1df-5232-4804-897e-917bf397618a".

  • type

    Function

• dojox.uuid.Uuid.isEqual

  • parameters:
    • otherUuid: (typeof dojox.uuid.Uuid)

      Any object that has toString() method that returns a 36-character string that conforms to the UUID spec.

  • returns

    boolean

  • summary

    Returns true if this UUID is equal to the otherUuid, or false otherwise.

  • type

    Function

• dojox.uuid.Uuid.isValid

  • summary

    Returns true if the UUID was initialized with a valid value.

  • type

    Function

• dojox.uuid.Uuid.getVariant

  • summary

    Returns a variant code that indicates what type of UUID this is.
    Returns one of the enumerated dojox.uuid.variant values.

  • example

    var uuid = new dojox.uuid.Uuid("3b12f1df-5232-4804-897e-917bf397618a");
    var variant = uuid.getVariant();
    dojox.uuid.assert(variant == dojox.uuid.variant.DCE);

  • example

    "3b12f1df-5232-4804-897e-917bf397618a"
    ^
    
    (variant "10__" == DCE)

  • type

    Function

• dojox.uuid.Uuid.getVersion

  • returns

    dojox.uuid.version

  • summary

    Returns a version number that indicates what type of UUID this is.
    Returns one of the enumerated dojox.uuid.version values.

  • example

    var uuid = new dojox.uuid.Uuid("b4308fb0-86cd-11da-a72b-0800200c9a66");
    var version = uuid.getVersion();
    dojox.uuid.assert(version == dojox.uuid.version.TIME_BASED);

  • exceptions

    Throws an Error if this is not a DCE Variant UUID.

  • type

    Function

• dojox.uuid.Uuid.getVersion._versionNumber

  • type

    Object

• dojox.uuid.Uuid.getNode

  • returns

    String (a 12-character string, which will look something like "917bf397618a")

  • summary

    If this is a version 1 UUID (a time-based UUID), getNode() returns a
    12-character string with the "node" or "pseudonode" portion of the UUID,
    which is the rightmost 12 characters.

  • exceptions

    Throws an Error if this is not a version 1 UUID.

  • type

    Function

• dojox.uuid.Uuid.getNode._nodeString

  • type

    Object

• dojox.uuid.Uuid.getTimestamp

  • parameters:
    • returnType: (typeof String)

      Any of these five values: "string", String, "hex", "date", Date

  • returns

    String (e.g. "Mon, 16 Jan 2006 20:21:41 GMT")|String (e.g. "1da86cdb4308fb0")|Date

  • summary

    If this is a version 1 UUID (a time-based UUID), this method returns
    the timestamp value encoded in the UUID.  The caller can ask for the
    timestamp to be returned either as a JavaScript Date object or as a
    15-character string of hex digits.

  • return_summary

    Returns the timestamp value as a JavaScript Date object or a 15-character string of hex digits.
    examples:
    var uuid = new dojox.uuid.Uuid("b4308fb0-86cd-11da-a72b-0800200c9a66");
    var date, string, hexString;
    date   = uuid.getTimestamp();         // returns a JavaScript Date
    date   = uuid.getTimestamp(Date);     //
    string = uuid.getTimestamp(String);   // "Mon, 16 Jan 2006 20:21:41 GMT"
    hexString = uuid.getTimestamp("hex"); // "1da86cdb4308fb0"

  • exceptions

    Throws an Error if this is not a version 1 UUID.

  • type

    Function

• dojox.uuid.Uuid.getTimestamp._timestampAsHexString

  • type

    Object

• dojox.uuid.Uuid.getTimestamp._timestampAsDate

  • type

    Object

• dojox.uuid

  • type

    Object

• dojox

  • type

    Object