universum.studios.android.util

Class BundleKey

java.lang.Object

universum.studios.android.util.BundleKey

public final class BundleKey
extends Object

Utility class that may be used to create keys for Bundle map.

Since:

2.0

Author:

Martin Albedinsky

Method Summary

Modifier and Type	Method and Description
static String	argument(Class<?> keyOwner, String keyName) Creates a key intended to be used to identify a single argument passed via Bundle.
static String	basic(Class<?> keyOwner, String keyName) Creates basic bundle key.
static String	create(Class<?> keyOwner, String keyName) Creates a new key with keyName for the specified keyOwner class.
static String	savedState(Class<?> keyOwner, String keyName) Creates a key intended to be used to identify a single value persisted in Bundle as saved state.

Methods inherited from class java.lang.Object

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

Method Detail

basic

@NonNull
public static String basic(@NonNull
                                    Class<?> keyOwner,
                                    @NonNull
                                    String keyName)

Creates basic bundle key.

Parameters:

keyOwner - Class which will "own" the key.

keyName - Name of the key to be created.

Returns:

Key in format 'fully.qualified.OwnerName.KEY.KeyName'.

See Also:

create(Class, String)

argument

@NonNull
public static String argument(@NonNull
                                       Class<?> keyOwner,
                                       @NonNull
                                       String keyName)

Creates a key intended to be used to identify a single argument passed via Bundle.

Parameters:

keyOwner - Class which will "own" the key.

keyName - Name of the key to be created.

Returns:

Key in format 'fully.qualified.OwnerName.ARGUMENT.KeyName'.

See Also:

create(Class, String)

savedState

@NonNull
public static String savedState(@NonNull
                                         Class<?> keyOwner,
                                         @NonNull
                                         String keyName)

Creates a key intended to be used to identify a single value persisted in Bundle as saved state.

Parameters:

keyOwner - Class which will "own" the key.

keyName - Name of the key to be created.

Returns:

Key in format 'fully.qualified.OwnerName.SAVED_STATE.KeyName'.

See Also:

create(Class, String)

create

@NonNull
public static String create(Class<?> keyOwner,
                                     String keyName)

Creates a new key with keyName for the specified keyOwner class.

Parameters:

keyOwner - Class which will "own" the key.

keyName - Name of the key to be created.

Returns:

Key consisting of fully qualified name of the given owner class appended with key name.