universum.studios.android.util

Class Flags

java.lang.Object

universum.studios.android.util.Flags

public class Flags
extends Object

This class represents a crate to store a set of integer flags instead of a boolean flags to improve memory efficiency of an Android application.

Note, that usage of this class to store int flags instead of boolean flags is efficient (in case of memory usage) only if you need to store and handle more than 4 boolean flags. It's because, the size of this object will be "always" 16 bytes and at the other hand the size of each of boolean flag is 4 bytes so if you have for example 8 booleans to handle some states, these boolean fields will together use 24 bytes of an available memory.

Of course, significant memory savings can be visible only in case when this class is used within the context of a class of which instances are in an android application used and instantiated in large amount, like hundreds or thousands of instances and more.

Since:

1.0

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
Flags() Creates a new instance of Flags with current flags initialized to 0.
Flags(int flags) Creates a new instance of Flags with the initial flags value.

Method Summary

Modifier and Type	Method and Description
Flags	add(int flag) Adds the specified flag to the current ones (if not presented yet).
int	get() Returns the current integer flags.
boolean	has(int flag) Checks whether the requested flag is presented within the current flags or not.
Flags	remove(int flag) Removes the specified flag from the current ones (if presented).
Flags	reset() Resets value of this flags to 0.

Methods inherited from class java.lang.Object

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

Constructor Detail

Flags

public Flags()

Creates a new instance of Flags with current flags initialized to 0.

Flags

public Flags(int flags)

Creates a new instance of Flags with the initial flags value.

Parameters:

flags - The initial value for flags.

Method Detail

add

public Flags add(int flag)

Adds the specified flag to the current ones (if not presented yet).

Parameters:

flag - The desired flag to add.

Returns:

This flags to allow methods chaining.

See Also:

has(int), get()

remove

public Flags remove(int flag)

Removes the specified flag from the current ones (if presented).

Parameters:

flag - The desired flag to remove.

Returns:

This flags to allow methods chaining.

See Also:

has(int), get()

has

public boolean has(int flag)

Checks whether the requested flag is presented within the current flags or not.

Parameters:

flag - The desired flag to check.

Returns:

True if flag is presented, false otherwise.

See Also:

add(int), remove(int), get()

get

public int get()

Returns the current integer flags.

Returns:

Current flags.

reset

public Flags reset()

Resets value of this flags to 0.

Returns:

This flags to allow methods chaining.