CmsUUID

java.lang.Object
- org.opencms.util.CmsUUID

所有已实现的接口:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<CmsUUID>
```
public final class CmsUUID
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<CmsUUID>, java.io.Externalizable
```
Generates a UUID using spatial and temporal uniqueness.
Spatial uniqueness is derived from ethernet address (MAC, 802.1); temporal from system clock.
For more information about the algorithm used, please see draft-leach-uuids-guids-01.txt.
Because Java is unable to read the MAC address of the machine (without using JNI), the MAC address has to be provided first by using the static init(String) method.
This class is just a facade wrapper for the "real" UUID implementation.

从以下版本开始:

6.0.0

另请参阅:
序列化表格

字段概要

字段
限定符和类型字段和说明

static java.lang.String UUID_REGEX
A regular expression for matching UUIDs.

字段
限定符和类型	字段和说明
`static java.lang.String`	`UUID_REGEX` A regular expression for matching UUIDs.

构造器概要

构造器
构造器和说明
`CmsUUID()` Creates a new UUID.
`CmsUUID(byte[] data)` Create a UUID based on a binary data array.
`CmsUUID(java.lang.String uuid)` Create a UUID based on a String.

方法概要

方法
限定符和类型	方法和说明
`static void`	`checkId(CmsUUID id, boolean canBeNull)` Check that the given id is not the null id.
`java.lang.Object`	`clone()` Creates a clone of this CmsUUID.
`int`	`compareTo(CmsUUID obj)`
`boolean`	`equals(java.lang.Object obj)`
`static CmsUUID`	`getConstantUUID(java.lang.String name)` Returns a constant (name based) UUID, based on the given name in the OpenCms name space.
`static java.lang.String`	`getDummyEthernetAddress()` Returns a String representing a dummy (random based) ethernet address.
`static CmsUUID`	`getNullUUID()` Returns a null UUID, use this null UUID to check if a UUID has been initialized or not.
`static CmsUUID`	`getOpenCmsUUID()` Returns a constant (name based) UUID for OpenCms, based on "www.opencms.org" in the dns name space.
`java.lang.String`	`getStringValue()` Returns the String representation of this UUID, same as `toString()`.
`int`	`hashCode()` Optimized hashCode implementation for UUID's.
`static void`	`init(java.lang.String ethernetAddress)` Initialize the UUID generator with the ethernet address of the server machine.
`boolean`	`isNullUUID()` Returns true if this UUID is equal to the null UUID.
`static boolean`	`isValidUUID(java.lang.String uuid)` Returns `true` if the given UUID is valid.
`void`	`readExternal(java.io.ObjectInput in)`
`byte[]`	`toByteArray()` Returns the UUID as a 16-byte byte array.
`java.lang.String`	`toString()`
`static CmsUUID`	`valueOf(java.lang.String uuid)` Returns the given String transformed to a UUID in case the String is a valid UUID.
`void`	`writeExternal(java.io.ObjectOutput out)`

从类继承的方法 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - UUID_REGEX
```
public static final java.lang.String UUID_REGEX
```
    A regular expression for matching UUIDs.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsUUID
```
public CmsUUID()
```
    Creates a new UUID.
    Please note that the static init() method has to be called first to initialize the internet address of the machine.
  - CmsUUID
```
public CmsUUID(byte[] data)
```
    Create a UUID based on a binary data array.
    
    参数:
    data - a binary data array representing a UUID
  - CmsUUID
```
public CmsUUID(java.lang.String uuid)
        throws java.lang.NumberFormatException
```
    Create a UUID based on a String.
    
    参数:
    uuid - a String representing a UUID
    
    抛出:
    
    java.lang.NumberFormatException - in case uuid is not a valid UUID
- 方法详细资料
  - checkId
```
public static void checkId(CmsUUID id,
           boolean canBeNull)
```
    Check that the given id is not the null id.
    
    参数:
    id - the id to check
    canBeNull - only if flag is set, null is accepted
    另请参阅:
    isNullUUID()
  - getConstantUUID
```
public static CmsUUID getConstantUUID(java.lang.String name)
```
    Returns a constant (name based) UUID, based on the given name in the OpenCms name space.
    
    参数:
    name - the name to derive the uuid from
    
    返回:
    name based UUID of the given name
  - getDummyEthernetAddress
```
public static java.lang.String getDummyEthernetAddress()
```
    Returns a String representing a dummy (random based) ethernet address.
    
    返回:
    a String representing a dummy (random based) ethernet address
  - getNullUUID
```
public static CmsUUID getNullUUID()
```
    Returns a null UUID, use this null UUID to check if a UUID has been initialized or not.
    
    返回:
    a null UUID
  - getOpenCmsUUID
```
public static CmsUUID getOpenCmsUUID()
```
    Returns a constant (name based) UUID for OpenCms, based on "www.opencms.org" in the dns name space.
    
    返回:
    name based UUID of OpenCms
  - init
```
public static void init(java.lang.String ethernetAddress)
                 throws CmsInitException
```
    Initialize the UUID generator with the ethernet address of the server machine.
    The ethernetAddress parameter must represent a 'standard' ethernet MAC address string (e.g. '00:C0:F0:3D:5B:7C').
    
    参数:
    ethernetAddress - the ethernet address of the server machine
    
    抛出:
    
    CmsInitException - in case the ethernetAddress String is not a valid ethernet address
  - isValidUUID
```
public static boolean isValidUUID(java.lang.String uuid)
```
    Returns true if the given UUID is valid.
    
    参数:
    uuid - the UUID to check
    
    返回:
    true if the given UUID is valid
  - valueOf
```
public static CmsUUID valueOf(java.lang.String uuid)
                       throws java.lang.NumberFormatException
```
    Returns the given String transformed to a UUID in case the String is a valid UUID.
    
    参数:
    uuid - the String to transform to a UUID
    
    返回:
    the given String transformed to a UUID in case the String is a valid UUID
    
    抛出:
    
    java.lang.NumberFormatException - in case the String is no valid UUID
  - clone
```
public java.lang.Object clone()
```
    Creates a clone of this CmsUUID.
    
    覆盖:
    
    clone 在类中 java.lang.Object
    
    返回:
    a clone of this CmsUUID
  - compareTo
```
public int compareTo(CmsUUID obj)
```
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<CmsUUID>
    
    另请参阅:
    Comparable.compareTo(Object)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
    
    另请参阅:
    Object.equals(java.lang.Object)
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the String representation of this UUID, same as toString().
    This method is useful if bean like access to the UUID String is required.
    
    返回:
    the String representation of this UUID
  - hashCode
```
public int hashCode()
```
    Optimized hashCode implementation for UUID's.
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    另请参阅:
    Object.hashCode()
  - isNullUUID
```
public boolean isNullUUID()
```
    Returns true if this UUID is equal to the null UUID.
    
    返回:
    true if this UUID is equal to the null UUID
  - readExternal
```
public void readExternal(java.io.ObjectInput in)
```
    指定者:
    
    readExternal 在接口中 java.io.Externalizable
    
    另请参阅:
    Externalizable.readExternal(java.io.ObjectInput)
  - toByteArray
```
public byte[] toByteArray()
```
    Returns the UUID as a 16-byte byte array.
    
    返回:
    16-byte byte array that contains the UUID's bytes in the network byte order
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
    
    另请参阅:
    Object.toString()
  - writeExternal
```
public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
```
    指定者:
    
    writeExternal 在接口中 java.io.Externalizable
    
    抛出:
    
    java.io.IOException
    另请参阅:
    Externalizable.writeExternal(java.io.ObjectOutput)

类 CmsUUID

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

UUID_REGEX

构造器详细资料

CmsUUID

CmsUUID

CmsUUID

方法详细资料

checkId

getConstantUUID

getDummyEthernetAddress

getNullUUID

getOpenCmsUUID

init

isValidUUID

valueOf

clone

compareTo

equals

getStringValue

hashCode

isNullUUID

readExternal

toByteArray

toString

writeExternal