org.jboss.shrinkwrap.descriptor.api.portletapp20

Interface PreferenceType<T>

All Superinterfaces:

Child<T>, PortletPreferenceCommonType<T,PreferenceType<T>>

public interface PreferenceType<T>
extends Child<T>, PortletPreferenceCommonType<T,PreferenceType<T>>

This interface defines the contract for the preferenceType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
List<String>	getAllValue() Returns all value elements
String	getId() Returns the id attribute
String	getName() Returns the name element
ReadOnlyType	getReadOnly() Returns the read-only element
String	getReadOnlyAsString() Returns the read-only element
PreferenceType<T>	id(String id) Sets the id attribute
PreferenceType<T>	name(String name) Sets the name element
PreferenceType<T>	readOnly(ReadOnlyType readOnly) Sets the read-only element
PreferenceType<T>	readOnly(String readOnly) Sets the read-only element
PreferenceType<T>	removeAllValue() Removes the value element
PreferenceType<T>	removeId() Removes the id attribute
PreferenceType<T>	removeName() Removes the name element
PreferenceType<T>	removeReadOnly() Removes the read-only attribute
PreferenceType<T>	value(String... values) Creates for all String objects representing value elements, a new value element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

name

PreferenceType<T> name(String name)

Sets the name element

Parameters:

name - the value for the element name

Returns:

the current instance of PreferenceType

getName

String getName()

Returns the name element

Returns:

the node defined for the element name

removeName

PreferenceType<T> removeName()

Removes the name element

Returns:

the current instance of PreferenceType

value

PreferenceType<T> value(String... values)

Creates for all String objects representing value elements, a new value element

Parameters:

values - list of value objects

Returns:

the current instance of PreferenceType

getAllValue

List<String> getAllValue()

Returns all value elements

Returns:

list of value

removeAllValue

PreferenceType<T> removeAllValue()

Removes the value element

Returns:

the current instance of PreferenceType

readOnly

PreferenceType<T> readOnly(ReadOnlyType readOnly)

Sets the read-only element

Parameters:

readOnly - the value for the element read-only

Returns:

the current instance of PreferenceType

readOnly

PreferenceType<T> readOnly(String readOnly)

Sets the read-only element

Parameters:

readOnly - the value for the element read-only

Returns:

the current instance of PreferenceType

getReadOnly

ReadOnlyType getReadOnly()

Returns the read-only element

Returns:

the value found for the element read-only

getReadOnlyAsString

String getReadOnlyAsString()

Returns the read-only element

Returns:

the value found for the element read-only

removeReadOnly

PreferenceType<T> removeReadOnly()

Removes the read-only attribute

Returns:

the current instance of PreferenceType

id

PreferenceType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of PreferenceType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

PreferenceType<T> removeId()

Removes the id attribute

Returns:

the current instance of PreferenceType