Module io.github.mmm.ui.api.controller

Package io.github.mmm.ui.api.controller

Class UiPlace

java.lang.Object

io.github.mmm.ui.api.controller.UiPlace

All Implemented Interfaces:

io.github.mmm.ui.api.attribute.AttributeReadId

public final class UiPlace
extends Object
implements io.github.mmm.ui.api.attribute.AttributeReadId

A place identifies a UiController in combination with its parameters. It allows to represent a specific state of the client that can be bookmarked and reopened at a later point in time.
HINT:
For each of your UiController you need to define an ID. To decouple your navigation from the actual UiController implementations, it is recommended to define them as constants in a places class per component or module. UiControllers may have mandatory or optional parameters. Therefore, it is recommended to create factory methods for your UiPlaces in the places class defining the constants that take the parameter values as properly typed arguments. This will make refactoring easier if parameters need to be changed. For generic access to your parameters please also define PARAMETER_* constants in your places class.

 public final class ExamplePlaces {

  private ExamplePlaces() {}

  public static final String ID_ADDRESS = "address";

  public static final String PARAMETER_ID = "id";

  public static UiPlace placeAddress(long id) {
    return UiPlace.of(ID_ADDRESS, PARAMETER_ID, id);
  }

  public static void navigateAddress(long id) {
    UiPlace place = placeAddress(id);
    UiNavigationManager.get().navigateTo(place);
  }

 

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static UiPlace	HOME	The default place to navigate to if the application is started without specifying a custom UiPlace.
static UiPlace	NONE	The initial place before the client is initialized by navigating to the first place.
static String	PATTERN_KEY	The regex pattern used to assert parameter keys.
static String	PATTERN_VALUE	The regex pattern used to assert parameter values.
static char	SEPARATOR_ANCHOR	The separator for anchor used to prevent that parameters are send to the server.
static char	SEPARATOR_PARAMETER	The separator used between parameters.
static char	SEPARATOR_STATE	The separator for dialog-id and its parameters.
static char	SEPARATOR_VALUE	The separator for key and value of a parameter.

Constructor Summary

Constructors

Constructor	Description
UiPlace(String id)	The constructor.
UiPlace(String id, Map<String,String> parameters)	The constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	get(String key)	This method gets a parameter of this UiPlace.
String	getId()
Integer	getInt(String key)	This method gets a parameter of this UiPlace.
int	getInt(String key, int defaultValue)	This method gets a parameter of this UiPlace.
Map<String,String>	getParameters()
boolean	has(String key)	This method determines if a get(String) is present (!= null).
int	hashCode()
static UiPlace	of(String id)
static UiPlace	of(String id, String key, Object value)
static UiPlace	of(String id, String key1, Object value1, String key2, Object value2)
static UiPlace	of(String id, String key1, Object value1, String key2, Object value2, String key3, Object value3)
static UiPlace	parse(String place)	This is the inverse operation of toString().
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR_STATE

public static final char SEPARATOR_STATE

The separator for dialog-id and its parameters.

See Also:

Constant Field Values

SEPARATOR_PARAMETER

public static final char SEPARATOR_PARAMETER

The separator used between parameters.

See Also:

Constant Field Values

SEPARATOR_VALUE

public static final char SEPARATOR_VALUE

The separator for key and value of a parameter.

See Also:

Constant Field Values

SEPARATOR_ANCHOR

public static final char SEPARATOR_ANCHOR

The separator for anchor used to prevent that parameters are send to the server.

See Also:

Constant Field Values

PATTERN_KEY

public static final String PATTERN_KEY

The regex pattern used to assert parameter keys.

See Also:

Constant Field Values

PATTERN_VALUE

public static final String PATTERN_VALUE

The regex pattern used to assert parameter values.

See Also:

Constant Field Values

NONE

public static final UiPlace NONE

The initial place before the client is initialized by navigating to the first place. This is not a valid place to navigate to.

HOME

public static final UiPlace HOME

The default place to navigate to if the application is started without specifying a custom UiPlace.

Constructor Detail

UiPlace

public UiPlace(String id)

The constructor.

Parameters:

id - the contoller ID.

UiPlace

public UiPlace(String id,
               Map<String,String> parameters)

The constructor.

Parameters:

id - the contoller ID.

parameters - the parameters.

Method Detail

getId

public final String getId()

Specified by:

getId in interface io.github.mmm.ui.api.attribute.AttributeReadId

Returns:

the ID of the UiController.

getParameters

public Map<String,String> getParameters()

Returns:

the Map of parameters.

has

public boolean has(String key)

This method determines if a get(String) is present (!= null).

Parameters:

key - is the name of the parameter to test.

Returns:

true if that parameter is present (NOT null), false otherwise.

get

public String get(String key)

This method gets a parameter of this UiPlace.

Parameters:

key - is the name of the requested parameter.

Returns:

the value of the requested parameter. Will be null if not set.

getInt

public Integer getInt(String key)

This method gets a parameter of this UiPlace.

Parameters:

key - is the name of the requested parameter.

Returns:

the value of the requested parameter. Will be null if not set.

getInt

public int getInt(String key,
                  int defaultValue)

This method gets a parameter of this UiPlace.

Parameters:

key - is the name of the requested parameter.

defaultValue - the default value to return if the parameter with the given key is not defined.

Returns:

the value of the requested parameter.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

parse

public static UiPlace parse(String place)

This is the inverse operation of toString().

Parameters:

place - is the string-representation of the UiPlace to create.

Returns:

the according UiPlace.

of

public static UiPlace of(String id)

Parameters:

id - is the controller ID.

Returns:

the new UiPlace.

of

public static UiPlace of(String id,
                         String key,
                         Object value)

Parameters:

id - is the controller ID.

key - the parameter key.

value - the parameter value.

Returns:

the new UiPlace.

of

public static UiPlace of(String id,
                         String key1,
                         Object value1,
                         String key2,
                         Object value2)

Parameters:

id - is the controller ID.

key1 - the first parameter key.

value1 - the fist parameter value.

key2 - the second parameter key.

value2 - the second parameter value.

Returns:

the new UiPlace.

of

public static UiPlace of(String id,
                         String key1,
                         Object value1,
                         String key2,
                         Object value2,
                         String key3,
                         Object value3)

Parameters:

id - is the controller ID.

key1 - the first parameter key.

value1 - the fist parameter value.

key2 - the second parameter key.

value2 - the second parameter value.

key3 - the third parameter key.

value3 - the third parameter value.

Returns:

the new UiPlace.