RegistryValue (JRegistry)

java.lang.Object
- com.registry.RegistryValue

All Implemented Interfaces:

Serializable, Cloneable, Comparable<RegistryValue>

Direct Known Subclasses:

RegBinaryValue, RegDWORDValue, RegMultiStringValue, RegQWORDValue, RegStringValue
```
public abstract class RegistryValue
extends Object
implements Cloneable, Comparable<RegistryValue>, Serializable
```
This class represents a named value that is found in the registry. Each value has a specific name which refers to the value as well as a type. The different types can be found in ValueType.
The data that is associated with the value depends on the type. For instance if a value was of type REG_SZ, then the data is a String type. If the type was REG_MULTI_SZ, then the data is an array of Strings.
This class can only retrieve the data in binary form. In order to obtain the data in its expected form, this class must be type cast into the appropriate class representing the value type for the named value.
For example: REG_SZ values must be type cast into RegStringValue.

Version:

1.8

Author:

Yinon Michaeli

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected RegistryKey`	`key` The key that contains `this` value.
`protected String`	`name` The name of the value.
`protected ValueType`	`type` The type of the value.
`protected int`	`typei` The integer representing the type of the value.
`protected Object`	`value` An object which holds the data.

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates a shallow copy of `this`.
`int`	`compareTo(RegistryValue o)` Implements the compareTo method in the interface `Comparable`.
`boolean`	`equals(Object o)` Tests for equality with another `Object`.
`byte[]`	`getByteData()` Used to retrieve the byte information of the data from the registry.
`int`	`getByteLength()` Used to retrieve the number of bytes the data takes up in the registry.
`RegistryKey`	`getKey()` Used to retrieve the registry key that contains `this` value.
`String`	`getName()` Used to retrieve the name of `this` value.
`ValueType`	`getValueType()` Used to retrieve the type of `this` value.
`int`	`getValueTypeInt()` Used to retrieve the type of `this` value.
`int`	`hashCode()` Calculates the hash code value for `this` value.
`abstract int`	`refreshData()` This method is used to update the data for `this` value because the data does not update automatically if it was changed.
`int`	`setByteData(byte... value)` Used to change the bytes of the data for `this` value.
`void`	`setValueType(ValueType type)` Used to change the type of `this` value.
`void`	`setValueTypeInt(int type)` Used to change the type of `this` value.
`String`	`toString()` Retrieve a `String` representation of `this` value.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
    The name of the value.
  - type
```
protected ValueType type
```
    The type of the value.
  - value
```
protected Object value
```
    An object which holds the data. Used in subclasses.
  - key
```
protected RegistryKey key
```
    The key that contains this value.
  - typei
```
protected int typei
```
    The integer representing the type of the value.
- Method Detail
  - clone
```
public Object clone()
```
    Creates a shallow copy of this.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    A copy of this value.
  - compareTo
```
public int compareTo(RegistryValue o)
```
    Implements the compareTo method in the interface Comparable. Allows a list of RegistryValues to be sorted in ascending order. Null values always come before non-null values.
    
    Specified by:
    
    compareTo in interface Comparable<RegistryValue>
    
    Parameters:
    o - A RegistryValue to compare against this.
    
    Returns:
    An integer describing which one should be sorted first: if < 0, this should go first if > 0, o should go first
  - equals
```
public boolean equals(Object o)
```
    Tests for equality with another Object. Two Objects are equal if they are both of type RegistryValue, they are both found in the same key, and their names, type, and data are the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - An Object to test equality with.
    
    Returns:
    true if the two are equal, false otherwise.
  - getKey
```
public RegistryKey getKey()
```
    Used to retrieve the registry key that contains this value.
    
    Returns:
    The registry key containing this.
    Since:
    
    1.8
  - getName
```
public String getName()
```
    Used to retrieve the name of this value.
    
    Returns:
    The name of the value.
  - hashCode
```
public int hashCode()
```
    Calculates the hash code value for this value.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    The hash code for this.
  - getValueType
```
public ValueType getValueType()
```
    Used to retrieve the type of this value.
    
    Returns:
    The type of the value.
  - getValueTypeInt
```
public int getValueTypeInt()
```
    Used to retrieve the type of this value.
    
    Returns:
    The type of the value as an integer.
    Since:
    
    1.4
  - setValueType
```
public void setValueType(ValueType type)
```
    Used to change the type of this value.
    
    Parameters:
    type - A ValueType describing what the new type will be.
  - setValueTypeInt
```
public void setValueTypeInt(int type)
```
    Used to change the type of this value.
    
    Parameters:
    type - An int describing what the new type will be.
    Since:
    
    1.4
  - refreshData
```
public abstract int refreshData()
```
    This method is used to update the data for this value because the data does not update automatically if it was changed.
    
    Returns:
    An integer error code which tells if the operation was successful or not. To obtain a description of the error, use RegistryKey.formatErrorMessage(int).
    Since:
    
    1.5
  - getByteData
```
public byte[] getByteData()
```
    Used to retrieve the byte information of the data from the registry. If the specific type is wanted, then this must be type cast to the corresponding subclass based on the type of the value.
    
    If the data cannot be read, then null is returned.
    
    Returns:
    An array of bytes which represent the data of the value or null if the data cannot be read.
  - setByteData
```
public int setByteData(byte... value)
```
    Used to change the bytes of the data for this value.
    
    Parameters:
    value - An array of bytes which will be the new data for the value. NOTE: As of version 1.7.6, this can now be a variable list of bytes.
    
    Returns:
    An integer error code which tells if the operation was successful or not. To obtain a description of the error, use RegistryKey.formatErrorMessage(int).
  - getByteLength
```
public int getByteLength()
```
    Used to retrieve the number of bytes the data takes up in the registry.
    
    Returns:
    The number of bytes for the value's data or -1 if the value doesn't exist.
  - toString
```
public String toString()
```
    Retrieve a String representation of this value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A String representation for the value.

Class RegistryValue

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

type

value

key

typei

Method Detail

clone

compareTo

equals

getKey

getName

hashCode

getValueType

getValueTypeInt

setValueType

setValueTypeInt

refreshData

getByteData

setByteData

getByteLength

toString