Package it.tidalwave.role.ui

Interface Displayable

All Known Subinterfaces:

LocalizedDisplayable, MutableDisplayable, MutableLocalizedDisplayable

All Known Implementing Classes:

PersonDisplayable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Displayable

The role of an object which can provide its own display name.

Author:

Fabrizio Giudici

Status: stable API

Stereotype:

Role

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.Class<Displayable>	_Displayable_
static Displayable	DEFAULT	A default Displayable with an empty display name.

Method Summary

Modifier and Type	Method	Description
static java.util.Comparator<As>	asComparing()	Returns a Comparator for comparing two instances of objects implementing As that contain the Displayable role.
static java.util.Comparator<Displayable>	comparing()	Returns a Comparator for comparing two instances of Displayable.
static LocalizedDisplayable	fromBundle(java.lang.Class<?> ownerClass, java.lang.String key)	Creates a LocalizedDisplayable from a resource bundle.
java.lang.String	getDisplayName()	Returns the display name in the current Locale.
static Displayable	of(java.lang.String displayName)	Creates an instance with a given display name.
static Displayable	of(java.lang.String displayName, java.lang.String toStringName)	Creates an instance with a given display name iand an explicit label for toString().
static <T> Displayable	of(java.util.function.Function<T,java.lang.String> function, T object)	Creates an instance from a Function<T, String> and a generic object that the function is applied to.
static Displayable	of(java.util.function.Supplier<java.lang.String> supplier)	Creates an instance from a Supplier<String>.

Field Detail

_Displayable_

static final java.lang.Class<Displayable> _Displayable_

DEFAULT

static final Displayable DEFAULT

A default Displayable with an empty display name.

Method Detail

getDisplayName

@Nonnull
java.lang.String getDisplayName()

Returns the display name in the current Locale.

Returns:

the display name

of

@Nonnull
static Displayable of(@Nonnull
                      java.lang.String displayName)

Creates an instance with a given display name.

Parameters:

displayName - the display name

Returns:

the new instance

Since:

3.2-ALPHA-1 (was DefaultDisplayable

of

@Nonnull
static Displayable of(@Nonnull
                      java.lang.String displayName,
                      @Nonnull
                      java.lang.String toStringName)

Creates an instance with a given display name iand an explicit label for toString().

Parameters:

displayName - the display name

toStringName - the name to be rendered when toString() is called

Returns:

the new instance

Since:

3.2-ALPHA-1 (was DefaultDisplayable

of

@Nonnull
static Displayable of(@Nonnull
                      java.util.function.Supplier<java.lang.String> supplier)

Creates an instance from a Supplier<String>. The supplier is invoked each time getDisplayName() is called.

Parameters:

supplier - the Supplier

Returns:

the new instance

Since:

3.2-ALPHA-3

of

@Nonnull
static <T> Displayable of(@Nonnull
                          java.util.function.Function<T,java.lang.String> function,
                          @Nonnull
                          T object)

Creates an instance from a Function<T, String> and a generic object that the function is applied to. The function is invoked each time getDisplayName() is called.

Type Parameters:

T - the type of the object

Parameters:

function - the Function

object - the object

Returns:

the new instance

Since:

3.2-ALPHA-3

fromBundle

@Nonnull
static LocalizedDisplayable fromBundle(@Nonnull
                                       java.lang.Class<?> ownerClass,
                                       @Nonnull
                                       java.lang.String key)

Creates a LocalizedDisplayable from a resource bundle. The bundle resource file is named Bundle.properties and it should be placed in the same package as the owner class.

Parameters:

ownerClass - the class that owns the bundle

key - the resource key

Returns:

the new instance

Since:

3.2-ALPHA-1 (was previously in Displayable8

comparing

@Nonnull
static java.util.Comparator<Displayable> comparing()

Returns a Comparator for comparing two instances of Displayable.

Returns:

the Comparator

Since:

3.2-ALPHA-6

asComparing

@Nonnull
static java.util.Comparator<As> asComparing()

Returns a Comparator for comparing two instances of objects implementing As that contain the Displayable role.

Returns:

the Comparator

Since:

3.2-ALPHA-6