com.registry

Class RegMultiStringValue

java.lang.Object

com.registry.RegistryValue

com.registry.RegMultiStringValue

All Implemented Interfaces:

Serializable, Cloneable, Comparable<RegistryValue>

public class RegMultiStringValue
extends RegistryValue

This class represents a named value of type REG_MULTI_SZ. The type specific data for the value will be an array of Strings.

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 an array of Strings.
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 an array of Strings.

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

Returns:

An array of Strings representing the data.

Throws:

RegistryException - if the type is not REG_MULTI_SZ.

setValue

public int setValue(String... value)

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

Parameters:

value - An array of Strings representing the new data for the value. NOTE: As of version 1.7.6, this can now be a variable list of Strings.

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