Package de.xima.fc.mdl.auth.filter

Class DefaultPluginProfileFilterValue

java.lang.Object

de.xima.fc.mdl.auth.filter.DefaultPluginProfileFilterValue

All Implemented Interfaces:

IPluginProfileFilterValue

public class DefaultPluginProfileFilterValue
extends Object
implements IPluginProfileFilterValue

Default implementation of a plugin profile attribute value.

Since:

8.0.0

Author:

XIMA Media GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultPluginProfileFilterValue.Builder

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription(Locale locale)	Returns an optional description of the possible value option.
String	getDisplayName(Locale locale)
IGuiIcon	getIcon()
String	getValue()
static DefaultPluginProfileFilterValue.Builder	newBuilder(String value)

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public String getValue()

Specified by:

getValue in interface IPluginProfileFilterValue

Returns:

the actual profile attribute value of this filter value option. Generally this should be an immutable value such as some form of ID and not e.g. editable display names.

getDisplayName

public String getDisplayName(Locale locale)

Specified by:

getDisplayName in interface IPluginProfileFilterValue

Parameters:

locale - Locale to be used for internationalization.

Returns:

the locale specific display name of the value.

getDescription

public String getDescription(Locale locale)

Description copied from interface: IPluginProfileFilterValue

Returns an optional description of the possible value option. This should be a helpful notice for the user for deciding on a filter value.

Specified by:

getDescription in interface IPluginProfileFilterValue

Parameters:

locale - Locale to be used for internationalization.

Returns:

the locale specific description.

getIcon

public IGuiIcon getIcon()

Specified by:

getIcon in interface IPluginProfileFilterValue

Returns:

an optional icon to be shown for the attribute value in the configuration GUI.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

newBuilder

public static DefaultPluginProfileFilterValue.Builder newBuilder(String value)