com.registry

Class RegDWORDValue

java.lang.Object

com.registry.RegistryValue

com.registry.RegDWORDValue

All Implemented Interfaces:

Serializable, Cloneable, Comparable<RegistryValue>

public class RegDWORDValue
extends RegistryValue

This class represents a named value of type REG_DWORD, REG_DWORD_LITTLE_ENDIAN, or REG_DWORD_BIG_ENDIAN. The type specific data for the value will be an Integer.

Version:

1.8

Author:

Yinon Michaeli

See Also:

RegistryValue, Serialized Form

Field Summary

Fields inherited from class com.registry.RegistryValue

key, name, type, typei, value

Method Summary

Methods

Modifier and Type	Method and Description
int	getIntValue() Convenience method to retrieve the data as an int primitive data type.
Integer	getValue() Retrieves the type specific form of this value which is an Integer.
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	setIntValue(int value) Convenience method to set the data using an int primitive data type.
int	setValue(Integer value) Used to set the data of this value.
String	toString() Retrieve a String representation of this value.

Methods inherited from class com.registry.RegistryValue

clone, compareTo, equals, getByteData, getByteLength, getKey, getName, getValueType, getValueTypeInt, hashCode, setByteData, setValueType, setValueTypeInt

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public Integer getValue()

Retrieves the type specific form of this value which is an Integer.

The Windows Registry uses unsigned integers for DWORDs, so negative values may be returned.

If the type was changed through a call to RegistryValue.setValueType(ValueType) and is no longer of type REG_DWORD, REG_DWORD_LITTLE_ENDIAN, or REG_DWORD_BIG_ENDIAN, then a RegistryException is thrown.

If the byte length for the data is not equal to 4, then a RegistryException is also thrown.

Returns:

An Integer representing the data.

Throws:

RegistryException - if the type is not REG_DWORD, REG_DWORD_LITTLE_ENDIAN, or REG_DWORD_BIG_ENDIAN; or if the byte length is not 4.

getIntValue

public int getIntValue()

Convenience method to retrieve the data as an int primitive data type.

Returns:

An int primitive data type representing the data.

See Also:

getValue()

setValue

public int setValue(Integer value)

Used to set the data of this value. If the type is no longer of type REG_DWORD, REG_DWORD_LITTLE_ENDIAN, or REG_DWORD_BIG_ENDIAN, then a RegistryException is thrown.

Parameters:

value - An Integer representing the new data for the value.

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).

Throws:

RegistryException - if the type is not REG_DWORD, REG_DWORD_LITTLE_ENDIAN, or REG_DWORD_BIG_ENDIAN.

setIntValue

public int setIntValue(int value)

Convenience method to set the data using an int primitive data type.

Parameters:

value - An int primitive data type representing the new data for the value.

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).

See Also:

setValue(Integer)

refreshData

public int refreshData()

This method is used to update the data for this value because the data does not update automatically if it was changed.

Specified by:

refreshData in class RegistryValue

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).

Throws:

RegistryException - if the type is not REG_DWORD_LITTLE_ENDIAN or REG_DWORD_BIG_ENDIAN.

Since:

1.5

toString

public String toString()

Retrieve a String representation of this value.

Overrides:

toString in class RegistryValue

Returns:

A String representation for the value.