com.registry

Class RegStringValue

java.lang.Object

com.registry.RegistryValue

com.registry.RegStringValue

All Implemented Interfaces:

Serializable, Cloneable, Comparable<RegistryValue>

public class RegStringValue
extends RegistryValue

This class represents a named value of type REG_SZ or REG_EXPAND_SZ. The type specific data for the value will be a String.

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
String	getValue() Retrieves the type specific form of this value which is a String.
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	setValue(String 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 String getValue()

Retrieves the type specific form of this value which is a String.

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

Returns:

A String representing the data.

Throws:

RegistryException - if the type is not REG_SZ or REG_EXPAND_SZ.

setValue

public int setValue(String value)

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

Parameters:

value - A String 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_SZ or REG_EXPAND_SZ.

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_SZ or REG_EXPAND_SZ.

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.