com.helger.photon.basic.app.page

Class AbstractPage

java.lang.Object

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

All Implemented Interfaces:

com.helger.commons.collection.attr.IHasAttributes<String,Object>, com.helger.commons.collection.attr.IHasAttributesAny<String>, com.helger.commons.collection.attr.IHasMutableAttributes<String,Object>, com.helger.commons.collection.attr.IHasMutableAttributesAny<String>, com.helger.commons.id.IHasID<String>, com.helger.commons.text.display.IHasDisplayText, IPage, Serializable

@NotThreadSafe
public abstract class AbstractPage
extends Object
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.IMultilingualText aName) Constructor
AbstractPage(String sID, com.helger.commons.text.IMultilingualText aName, com.helger.commons.text.IMultilingualText aDescription) Constructor
AbstractPage(String sID, String sName) Constructor
AbstractPage(String sID, String sName, String sDescription) Constructor

Method Summary

Modifier and Type	Method and Description
static com.helger.commons.text.ReadOnlyMultilingualText	getAsMLT(String sText)
com.helger.commons.text.IMultilingualText	getDescription()
String	getDescription(Locale aContentLocale) Get the description of the page in the passed locale.
String	getDisplayText(Locale aContentLocale)
String	getID()
com.helger.commons.collection.attr.IMutableAttributeContainerAny<String>	getMutableAttributes()
com.helger.commons.text.IMultilingualText	getName()
void	setDescription(com.helger.commons.text.IMultilingualText aDescription) Set the description of the page.
void	setName(com.helger.commons.text.IMultilingualText aName) Set the name of the page.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getAsHasText, getComparatorCollating

Methods inherited from interface com.helger.commons.collection.attr.IHasMutableAttributesAny

getAttributes

Methods inherited from interface com.helger.commons.collection.attr.IHasAttributes

getAllAttributes

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.IMultilingualText 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.IMultilingualText aName,
                    @Nullable
                    com.helger.commons.text.IMultilingualText 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

getAsMLT

@Nullable
public static com.helger.commons.text.ReadOnlyMultilingualText getAsMLT(@Nullable
                                                                                   String sText)

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.IMultilingualText 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.IMultilingualText 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.text.display.IHasDisplayText

setDescription

public final void setDescription(@Nullable
                                 com.helger.commons.text.IMultilingualText 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.IMultilingualText 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.

getMutableAttributes

@Nonnull
 @ReturnsMutableObject(value="design")
public com.helger.commons.collection.attr.IMutableAttributeContainerAny<String> getMutableAttributes()

Specified by:

getMutableAttributes in interface com.helger.commons.collection.attr.IHasMutableAttributes<String,Object>

Specified by:

getMutableAttributes in interface com.helger.commons.collection.attr.IHasMutableAttributesAny<String>

toString

public String toString()

Overrides:

toString in class Object