com.helger.photon.basic.app.page

Class AbstractPage

java.lang.Object

com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer<KEYTYPE,VALUETYPE>

com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>

com.helger.commons.collections.attrs.MapBasedAttributeContainer

com.helger.photon.basic.app.page.AbstractPage

All Implemented Interfaces:

com.helger.commons.collections.attrs.IAttributeContainer, com.helger.commons.collections.attrs.IGenericAttributeContainer<String,Object>, com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer<String,Object>, com.helger.commons.collections.attrs.IReadonlyAttributeContainer, com.helger.commons.ICloneable<com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>>, com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDisplayText, com.helger.commons.state.IClearable, IPage, Serializable

public abstract class AbstractPage
extends com.helger.commons.collections.attrs.MapBasedAttributeContainer
implements IPage

Abstract base implementation for IPage.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPage(String sID) Constructor
AbstractPage(String sID, com.helger.commons.text.IReadonlyMultiLingualText aName) Constructor
AbstractPage(String sID, com.helger.commons.text.IReadonlyMultiLingualText aName, com.helger.commons.text.IReadonlyMultiLingualText aDescription) Constructor
AbstractPage(String sID, String sName) Constructor
AbstractPage(String sID, String sName, String sDescription) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
com.helger.commons.text.IReadonlyMultiLingualText	getDescription()
String	getDescription(Locale aContentLocale) Get the description of the page in the passed locale.
String	getDisplayText(Locale aContentLocale)
String	getID()
com.helger.commons.text.IReadonlyMultiLingualText	getName()
void	setDescription(com.helger.commons.text.IReadonlyMultiLingualText aDescription) Set the description of the page.
void	setName(com.helger.commons.text.IReadonlyMultiLingualText aName) Set the name of the page.
String	toString()

Methods inherited from class com.helger.commons.collections.attrs.MapBasedAttributeContainer

getAndSetAttributeFlag, getClone, setAttribute, setAttribute, setAttribute, setAttribute

Methods inherited from class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer

clear, containsAttribute, containsNoAttribute, equals, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeCount, getAttributeNames, getAttributeObject, hashCode, onBeforeRemoveAttribute, onBeforeSetAttributeValue, removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from class com.helger.commons.collections.attrs.AbstractGenericReadonlyAttributeContainer

getAsBigDecimal, getAsBigInteger, getAsBoolean, getAsDouble, getAsInt, getAsLong, getAsString, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collections.attrs.IGenericReadonlyAttributeContainer

containsAttribute, containsNoAttribute, getAllAttributeNames, getAllAttributes, getAllAttributeValues, getAttributeAsBigDecimal, getAttributeAsBigDecimal, getAttributeAsBigInteger, getAttributeAsBigInteger, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDouble, getAttributeAsDouble, getAttributeAsInt, getAttributeAsInt, getAttributeAsLong, getAttributeAsLong, getAttributeAsString, getAttributeAsString, getAttributeCount, getAttributeNames, getAttributeObject, getCastedAttribute, getCastedAttribute, getTypedAttribute, getTypedAttribute

Methods inherited from interface com.helger.commons.collections.attrs.IGenericAttributeContainer

removeAttribute, setAttribute, setAttributes, setAttributes

Methods inherited from interface com.helger.commons.state.IClearable

clear

Constructor Detail

AbstractPage

public AbstractPage(@Nonnull@Nonempty
            String sID)

Constructor

Parameters:

sID - The unique page ID. May not be null.

AbstractPage

public AbstractPage(@Nonnull@Nonempty
            String sID,
            @Nonnull
            String sName)

Constructor

Parameters:

sID - The unique page ID. May not be null.

sName - The constant (non-translatable) name of the page. May not be null.

AbstractPage

public AbstractPage(@Nonnull@Nonempty
            String sID,
            @Nonnull
            String sName,
            @Nullable
            String sDescription)

Constructor

Parameters:

sID - The unique page ID. May not be null.

sName - The constant (non-translatable) name of the page. May not be null.

sDescription - The constant (non-translatable) description of the page. May be null.

AbstractPage

public AbstractPage(@Nonnull@Nonempty
            String sID,
            @Nonnull
            com.helger.commons.text.IReadonlyMultiLingualText aName)

Constructor

Parameters:

sID - The unique page ID. May not be null.

aName - The name of the page. May not be null.

AbstractPage

public AbstractPage(@Nonnull@Nonempty
            String sID,
            @Nonnull
            com.helger.commons.text.IReadonlyMultiLingualText aName,
            @Nullable
            com.helger.commons.text.IReadonlyMultiLingualText aDescription)

Constructor

Parameters:

sID - The unique page ID. May not be null.

aName - The name of the page. May not be null.

aDescription - Optional description of the page. May be null.

Method Detail

getID

@Nonnull
@Nonempty
public final String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

setName

public final void setName(@Nonnull
           com.helger.commons.text.IReadonlyMultiLingualText aName)

Set the name of the page.

Parameters:

aName - The multilingual name of the page. May not be null.

getName

@Nonnull
public final com.helger.commons.text.IReadonlyMultiLingualText getName()

Returns:

The complete name of the page in all available locales. Never null.

getDisplayText

@Nullable
public final String getDisplayText(@Nonnull
                             Locale aContentLocale)

Specified by:

getDisplayText in interface com.helger.commons.name.IHasDisplayText

setDescription

public final void setDescription(@Nullable
                  com.helger.commons.text.IReadonlyMultiLingualText aDescription)

Set the description of the page.

Parameters:

aDescription - The multilingual description of the page. May be null.

getDescription

@Nullable
public final com.helger.commons.text.IReadonlyMultiLingualText getDescription()

Returns:

The complete description of the page in all available locales. May be null.

getDescription

@Nullable
public final String getDescription(@Nonnull
                             Locale aContentLocale)

Description copied from interface: IPage

Get the description of the page in the passed locale.

Specified by:

getDescription in interface IPage

Parameters:

aContentLocale - The content locale to get the description from. May not be null.

Returns:

null if no description text in the specified locale is available.

toString

public String toString()

Overrides:

toString in class com.helger.commons.collections.attrs.MapBasedGenericAttributeContainer<String,Object>