com.rollbar.utilities

Class Extensible<T extends Extensible<T>>

java.lang.Object

com.rollbar.utilities.Extensible<T>

Type Parameters:

T - The extensible type itself.

All Implemented Interfaces:

JsonSerializable

public abstract class Extensible<T extends Extensible<T>>
extends Object
implements JsonSerializable

Base class for classes that can be extended with arbitrary metadata (as per the Rollbar spec). This class, unlike the rest of the classes is mutable. Extra caution is therefore warranted.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Extensible(Map<String,Object> members) Constructor

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asJson()
abstract T	copy() Copy this item.
Object	get(String name) Get the member, or null if not present.
protected abstract Set<String>	getKnownMembers() Returns the 'known' keys, that are specially treated by Rollbar
Map<String,Object>	getMembers() Get a copy of the members.
Set<String>	keys(boolean withoutKnownMembers) Get the keys in this extensible
T	put(String name, Object value) Sets the member.
protected void	putKnown(String name, Object value) MUTATING.

Methods inherited from class java.lang.Object

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

Constructor Detail

Extensible

protected Extensible(Map<String,Object> members)

Constructor

Parameters:

members - the LinkedHashMap of all members already in this object

Method Detail

getKnownMembers

protected abstract Set<String> getKnownMembers()

Returns the 'known' keys, that are specially treated by Rollbar

Returns:

the set of known keys

get

public Object get(String name)

Get the member, or null if not present.

Parameters:

name - the member name

Returns:

null or the member at that key

copy

public abstract T copy()

Copy this item. Needs to be custom per subclass. Should return the subclass itself (not an Extensible).

Returns:

An exact copy of this object.

put

public T put(String name,
             Object value)
      throws IllegalArgumentException

Sets the member. Cannot be used to set known members.

Parameters:

name - the member name to set.

value - the value to set.

Returns:

this object.

Throws:

IllegalArgumentException

putKnown

protected void putKnown(String name,
                        Object value)

MUTATING. Use only in Constructor.

Parameters:

name - the key

value - the value

keys

public Set<String> keys(boolean withoutKnownMembers)

Get the keys in this extensible

Parameters:

withoutKnownMembers - true if you want to leave out known members

Returns:

the keys

getMembers

public Map<String,Object> getMembers()

Get a copy of the members.

Returns:

a copy of the members in this Extensible.

asJson

public Map<String,Object> asJson()

Specified by:

asJson in interface JsonSerializable