org.itsnat.core
Interface ItsNatUserData

All Known Subinterfaces:

ClientDocument, CometNotifier, ElementGroup, ElementLabel, ElementList, ElementListBase, ElementListFree, ElementTable, ElementTableBase, ElementTableFree, ElementTree, ElementTreeNode, ElementTreeNodeList, HTMLIFrameFileUpload, ItsNat, ItsNatAsyncTaskEvent, ItsNatAttachedClientCometEvent, ItsNatAttachedClientEvent, ItsNatAttachedClientTimerEvent, ItsNatButton, ItsNatButtonCheckBox, ItsNatButtonLabel, ItsNatButtonNormal, ItsNatButtonRadio, ItsNatButtonToggle, ItsNatComboBox, ItsNatCometEvent, ItsNatComponent, ItsNatContinueEvent, ItsNatDocFragmentTemplate, ItsNatDocument, ItsNatDocumentTemplate, ItsNatDOMExtEvent, ItsNatDOMStdEvent, ItsNatElementComponent, ItsNatEvent, ItsNatFormattedTextField, ItsNatFreeButtonNormal, ItsNatFreeButtonNormalLabel, ItsNatFreeButtonToggle, ItsNatFreeCheckBox, ItsNatFreeCheckBoxLabel, ItsNatFreeComboBox, ItsNatFreeComponent, ItsNatFreeInclude, ItsNatFreeLabel, ItsNatFreeList, ItsNatFreeListMultSel, ItsNatFreeRadioButton, ItsNatFreeRadioButtonLabel, ItsNatFreeTable, ItsNatFreeTableHeader, ItsNatFreeTree, ItsNatHTMLAnchor, ItsNatHTMLAnchorLabel, ItsNatHTMLButton, ItsNatHTMLButtonLabel, ItsNatHTMLDocFragmentTemplate, ItsNatHTMLDocument, ItsNatHTMLElementComponent, ItsNatHTMLForm, ItsNatHTMLFormComponent, ItsNatHTMLIFrame, ItsNatHTMLInput, ItsNatHTMLInputButton, ItsNatHTMLInputButtonNormal, ItsNatHTMLInputButtonToggle, ItsNatHTMLInputCheckBox, ItsNatHTMLInputFile, ItsNatHTMLInputHidden, ItsNatHTMLInputImage, ItsNatHTMLInputPassword, ItsNatHTMLInputRadio, ItsNatHTMLInputReset, ItsNatHTMLInputSubmit, ItsNatHTMLInputText, ItsNatHTMLInputTextBased, ItsNatHTMLInputTextFormatted, ItsNatHTMLLabel, ItsNatHTMLSelect, ItsNatHTMLSelectComboBox, ItsNatHTMLSelectMult, ItsNatHTMLTable, ItsNatHTMLTableHeader, ItsNatHTMLTextArea, ItsNatHttpServletRequest, ItsNatHttpServletResponse, ItsNatHttpSession, ItsNatInclude, ItsNatKeyEvent, ItsNatLabel, ItsNatList, ItsNatListCellUI, ItsNatListMultSel, ItsNatModalLayer, ItsNatNode, ItsNatNormalEvent, ItsNatPasswordField, ItsNatServletConfig, ItsNatServletContext, ItsNatServletRequest, ItsNatServletResponse, ItsNatSession, ItsNatTable, ItsNatTableCellUI, ItsNatTableHeader, ItsNatTableHeaderCellUI, ItsNatTextArea, ItsNatTextComponent, ItsNatTextField, ItsNatTimerEvent, ItsNatTimerHandle, ItsNatTree, ItsNatTreeCellUI, ItsNatUserEvent, ListElementInfo, MarkupTemplate, TableCellElementInfo

public interface ItsNatUserData

This basic interface provides a user data registry. This registry is in no way used by the framework.

Most of ItsNat objects implement this interface to help the user to reduce the work of wiring user data with ItsNat objects.

User data registry methods are synchronized if this object is a ItsNatServletContext, ItsNatServlet, ItsNatServletConfig, ItsNatSession, MarkupTemplate or CometNotifier otherwise are unsynchronized.

Method Summary

boolean	containsUserValueName(java.lang.String name) Informs whether the registry contains one pair name/value with the specified name.
java.lang.Object	getUserValue(java.lang.String name) Returns the value associated to the specified name.
java.lang.String[]	getUserValueNames() Returns all registered names.
java.lang.Object	removeUserValue(java.lang.String name) Removes the name/value registry with the specified name.
java.lang.Object	setUserValue(java.lang.String name, java.lang.Object value) Sets a new value associated to the specified name.

Method Detail

containsUserValueName

boolean containsUserValueName(java.lang.String name)

Informs whether the registry contains one pair name/value with the specified name.

Parameters:

name - the name to look for.

Returns:

true if there is a name/value pair with this name.

getUserValue

java.lang.Object getUserValue(java.lang.String name)

Returns the value associated to the specified name.

Parameters:

name - the name to look for.

Returns:

the value associated or null if not found.

setUserValue

java.lang.Object setUserValue(java.lang.String name,
                              java.lang.Object value)

Sets a new value associated to the specified name.

Parameters:

name - the name used to register.

value - the value with the specified name.

Returns:

the old value associated to this name or null if none.

removeUserValue

java.lang.Object removeUserValue(java.lang.String name)

Removes the name/value registry with the specified name.

Parameters:

name - the name to look for.

Returns:

the associated value or null if no registry has this name.

getUserValueNames

java.lang.String[] getUserValueNames()

Returns all registered names.

Returns:

an array with all registered names.