com.zackehh.dotnotes.util

Class NotedKey

java.lang.Object

com.zackehh.dotnotes.util.NotedKey

public class NotedKey
extends Object

A wrapping class for a potential key - keys can be either Strings or Integers, depending on whether we're working with an Array or an Object. This class simply allows for safer usage under the circumstances.

Method Summary

Modifier and Type	Method and Description
Integer	asNumber() Returns the internal key as an Integer, assuming it is a Integer.
String	asString() Returns the internal key as a String, assuming it is a String.
boolean	isNumber() Determines whether the internal key is a Number or not.
boolean	isString() Determines whether the internal key is a String or not.
static NotedKey	of(Object o) Static creation method accepting an Object.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

asNumber

public Integer asNumber()

Returns the internal key as an Integer, assuming it is a Integer. If it's not a Integer, you'll get a null value.

Returns:

the internal key as a Integer

asString

public String asString()

Returns the internal key as a String, assuming it is a String. If it's not a String, you'll get a null value.

Returns:

the internal key as a String

isNumber

public boolean isNumber()

Determines whether the internal key is a Number or not.

Returns:

true if the key is a Number

isString

public boolean isString()

Determines whether the internal key is a String or not.

Returns:

true if the key is a String

of

public static NotedKey of(Object o)

Static creation method accepting an Object. If the Object is a valid String, it will create a NotedKey wrapping a String. Likewise if the Object is a Number, same applies with a Number value. If neither match, a null value is simply returned.

Parameters:

o - the Object to create for

Returns:

a NotedKey wrapping a valid key

toString

public String toString()

Overrides:

toString in class Object