Package dollar.api.types

Class DollarNull

java.lang.Object

dollar.api.types.AbstractDollar

dollar.api.types.DollarNull

All Implemented Interfaces:

StateAware<Value>, Value, Serializable, Comparable<Value>

public class DollarNull
extends AbstractDollar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DollarNull(@NotNull com.google.common.collect.ImmutableList<Throwable> errors, @NotNull Type type)
DollarNull(@NotNull Type type)

Method Summary

Modifier and Type	Method	Description
@NotNull Value	$abs()	Computes the absolute value for this object.
@NotNull Value	$append(@NotNull Value value)
@NotNull Value	$as(@NotNull Type type)	Cast this object to the Type specified.
@NotNull Value	$containsKey(@NotNull Value value)
@NotNull Value	$containsValue(@NotNull Value value)
@NotNull Value	$divide(@NotNull Value rhs)	Divide the value.
@NotNull Value	$get(@NotNull Value key)
@NotNull Value	$has(@NotNull Value key)	Returns true if this object has the supplied key.
@NotNull Value	$insert(@NotNull Value value, int position)
@NotNull Value	$minus(@NotNull Value rhs)	Deducts from Value, for toStrings this means remove all occurrence of and for collections it means remove the value from the collection.
@NotNull Value	$modulus(@NotNull Value rhs)	Returns the remainder after a division.
@NotNull Value	$multiply(@NotNull Value v)	$ multiply.
@NotNull Value	$negate()	Negate the value, for lists, toStrings and maps this means reversing the elements.
@NotNull Value	$plus(@NotNull Value rhs)	Returns a new Value with this value added to it.
@NotNull Value	$prepend(@NotNull Value value)
@NotNull Value	$remove(@NotNull Value value)	Return a new version of this object with the supplied value removed.
@NotNull Value	$removeByKey(@NotNull String value)	Remove by key.
@NotNull Value	$set(@NotNull Value key, @NotNull Object value)	If this type supports the setting of Key/Value pairs this will set the supplied key value pair on a copy of this object.
@NotNull Value	$size()
@NotNull Type	$type()	Returns the definitive type of this object, this will trigger execution in dynamic values.
boolean	collection()	Is collection.
int	compareTo(@NotNull Value o)
boolean	equals(Object other)
int	hashCode()
boolean	is(@NotNull Type... types)	Returns true if this object is of any of the supplied types.
boolean	isBoolean()	Is boolean.
boolean	isFalse()	Is false.
boolean	isNull()	Returns true if this is a null value, the null value is not the same as a void value.
boolean	isTrue()	Is true.
boolean	isVoid()	Is this object a void object? Void objects are a similar concept to nil in Objective-C, any operation on them results in a void value.
boolean	neitherTrueNorFalse()	Is neither true nor false.
@NotNull Value	remove(@NotNull Object value)	Convenience version of Value.$remove(Value) for the Java API.
int	sign()	Sign int.
@org.jetbrains.annotations.NotNull int	size()
@NotNull String	toDollarScript()	Convert this value to a DollarScript compatible string value.
@NotNull String	toHumanString()	Converts this value to a human readable string.
int	toInteger()	toInteger integer.
<K extends Comparable<K>,V> @NotNull com.google.common.collect.ImmutableMap<K,V>	toJavaMap()	Returns this object as a set of nested maps the values are completely unwrapped and don't contain 'Value' objects.
<R> R	toJavaObject()	Returns the underlying storage value for this type.
@NotNull String	toJsonString()	Convert this to a Dollar JsonObject
@NotNull com.google.common.collect.ImmutableList<Object>	toList()	Converts this to a list of value objects such as you would get from $().
@NotNull Number	toNumber()	toNumber number.
com.google.common.collect.ImmutableList<String>	toStrings()	Returns this object as a list of string values or null if this is not applicable.
@NotNull com.google.common.collect.ImmutableList<Value>	toVarList()	Converts this to a list of vars.
@NotNull com.google.common.collect.ImmutableMap<Value,Value>	toVarMap()	$ map.
@NotNull String	toYaml()	$ map.
boolean	truthy()	Is truthy, i.e.

Methods inherited from class dollar.api.types.AbstractDollar

$all, $avg, $choose, $constrain, $copy, $copy, $create, $default, $destroy, $drain, $each, $fix, $fix, $fixDeep, $max, $min, $notify, $pause, $product, $publish, $read, $reverse, $signal, $sort, $start, $state, $stop, $sum, $unique, $unpause, $unwrap, $write, constraintLabel, debug, debug, debugf, decimal, dynamic, error, error, error, errorf, getStateMachine, info, info, infof, integer, list, map, meta, meta, metaAttribute, metaAttribute, number, pair, predictType, queue, singleValue, string, toDouble, toLong, toStream, toString, uri

Methods inherited from class java.lang.Object

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

Methods inherited from interface dollar.api.Value

$, $cancel, $contains, $dec, $dispatch, $equals, $fixDeep, $give, $has, $inc, $isEmpty, $list, $listen, $listen, $map, $mimeType, $notEquals, $pairKey, $pairValue, $peek, $poll, $pop, $push, $read, $S, $serialized, $split, $stream, $subscribe, $subscribe, $write, equalsString, err, infinite, isEmpty, jsonArray, negative, out, positive, range, source, stream, toJsonObject, toJsonType, type, zero

Constructor Detail

DollarNull

public DollarNull(@NotNull
                  @NotNull com.google.common.collect.ImmutableList<Throwable> errors,
                  @NotNull
                  @NotNull Type type)

DollarNull

public DollarNull(@NotNull
                  @NotNull Type type)

Method Detail

$abs

@NotNull
public @NotNull Value $abs()

Description copied from interface: Value

Computes the absolute value for this object. Currently the result is only defined for numeric values.

Returns:

the absolute value

$append

@NotNull
public @NotNull Value $append(@NotNull
                              @NotNull Value value)

$as

@NotNull
public @NotNull Value $as(@NotNull
                          @NotNull Type type)

Description copied from interface: Value

Cast this object to the Type specified. If the object cannot be converted it will fail with ErrorType.INVALID_CAST*

Parameters:

type - the type to cast to

Returns:

this casted

$containsKey

@NotNull
public @NotNull Value $containsKey(@NotNull
                                   @NotNull Value value)

$containsValue

@NotNull
public @NotNull Value $containsValue(@NotNull
                                     @NotNull Value value)

$divide

@NotNull
public @NotNull Value $divide(@NotNull
                              @NotNull Value rhs)

Description copied from interface: Value

Divide the value. For toStrings this means splitting. For numbers this is the usual numerical division.

Parameters:

rhs - the value to divide by

Returns:

the divided value

$get

@NotNull
public @NotNull Value $get(@NotNull
                           @NotNull Value key)

$has

@NotNull
public @NotNull Value $has(@NotNull
                           @NotNull Value key)

Description copied from interface: Value

Returns true if this object has the supplied key.

Parameters:

key - the key

Returns:

true if the key exists.

$insert

@NotNull
public @NotNull Value $insert(@NotNull
                              @NotNull Value value,
                              int position)

$minus

@NotNull
public @NotNull Value $minus(@NotNull
                             @NotNull Value rhs)

Description copied from interface: Value

Deducts from Value, for toStrings this means remove all occurrence of and for collections it means remove the value from the collection. For numbers it is standard numeric arithmetic.

Parameters:

rhs - the value to deduct from this

Returns:

the new value

$modulus

@NotNull
public @NotNull Value $modulus(@NotNull
                               @NotNull Value rhs)

Description copied from interface: Value

Returns the remainder after a division.

Parameters:

rhs - the value to divide by

Returns:

the remainder

$multiply

@NotNull
public @NotNull Value $multiply(@NotNull
                                @NotNull Value v)

Description copied from interface: Value

$ multiply.

Parameters:

v - the v

Returns:

the Value

$negate

@NotNull
public @NotNull Value $negate()

Description copied from interface: Value

Negate the value, for lists, toStrings and maps this means reversing the elements. For numbers it is the usual numeric negation.

Returns:

the negated value

$plus

@NotNull
public @NotNull Value $plus(@NotNull
                            @NotNull Value rhs)

Description copied from interface: Value

Returns a new Value with this value added to it. Like Value.$minus(Value) the actual behaviour varies with types. So for toStrings this is concatenation for collections it is adding a new element.

Parameters:

rhs - the value to add

Returns:

a new object with the value supplied added

$prepend

@NotNull
public @NotNull Value $prepend(@NotNull
                               @NotNull Value value)

$remove

@NotNull
public @NotNull Value $remove(@NotNull
                              @NotNull Value value)

Description copied from interface: Value

Return a new version of this object with the supplied value removed. THe removal is type specific.

Parameters:

value - the value to remove.

Returns:

a new object with the value removed.

$removeByKey

@NotNull
public @NotNull Value $removeByKey(@NotNull
                                   @NotNull String value)

Description copied from interface: Value

Remove by key. (Map like data only).

Parameters:

value - the key of the key/value pair to remove

Returns:

the modified Value

$set

@NotNull
public @NotNull Value $set(@NotNull
                           @NotNull Value key,
                           @NotNull
                           @NotNull Object value)

Description copied from interface: Value

If this type supports the setting of Key/Value pairs this will set the supplied key value pair on a copy of this object. If it doesn't an exception will be thrown.

Parameters:

key - a String key for the value to be stored in this value.

value - the Value to add.

Returns:

the updated copy.

$size

@NotNull
public @NotNull Value $size()

$type

@NotNull
public @NotNull Type $type()

Description copied from interface: Value

Returns the definitive type of this object, this will trigger execution in dynamic values.

Returns:

the type

collection

public boolean collection()

Description copied from interface: Value

Is collection.

Returns:

the boolean

is

public boolean is(@NotNull
                  @NotNull Type... types)

Description copied from interface: Value

Returns true if this object is of any of the supplied types.

Parameters:

types - a list of types

Returns:

true if of one of the types

isBoolean

public boolean isBoolean()

Description copied from interface: Value

Is boolean.

Returns:

true if this object is a boolean

isFalse

public boolean isFalse()

Description copied from interface: Value

Is false.

Returns:

true if this object is a boolean and is false

isNull

public boolean isNull()

Description copied from interface: Value

Returns true if this is a null value, the null value is not the same as a void value. A void value does not take up space in a collection, i.e. it has no size. A null however does and can optionally have a type also.

Returns:

true if this is a null value

isTrue

public boolean isTrue()

Description copied from interface: Value

Is true.

Returns:

true if this object is a boolean and is true

isVoid

public boolean isVoid()

Description copied from interface: Value

Is this object a void object? Void objects are a similar concept to nil in Objective-C, any operation on them results in a void value. However they take up no space in a collection. So are closer to the Java concept of void. If you wish to represent a non-existent value use void (think of this like a zero length array ). If you wish to represent a lack of value use null (think of this as a single length array with no assigned value.

Returns:

true if this is a void object

neitherTrueNorFalse

public boolean neitherTrueNorFalse()

Description copied from interface: Value

Is neither true nor false.

Returns:

true if this object is neither true nor false

remove

@NotNull
public @NotNull Value remove(@NotNull
                             @NotNull Object value)

Description copied from interface: Value

Convenience version of Value.$remove(Value) for the Java API.

Parameters:

value - the value to be removed.

Returns:

a new object with the value removed.

sign

public int sign()

Description copied from interface: Value

Sign int.

Returns:

the int

size

@NotNull
public @org.jetbrains.annotations.NotNull int size()

toDollarScript

@NotNull
public @NotNull String toDollarScript()

Description copied from interface: Value

Convert this value to a DollarScript compatible string value. Note that dynamic values will be executed to provide this. The string only represents the computed value.

Returns:

toHumanString

@NotNull
public @NotNull String toHumanString()

Description copied from interface: Value

Converts this value to a human readable string.

Returns:

the string

toInteger

public int toInteger()

Description copied from interface: Value

toInteger integer.

Returns:

the integer

toJavaMap

@NotNull
public <K extends Comparable<K>,V> @NotNull com.google.common.collect.ImmutableMap<K,V> toJavaMap()

Description copied from interface: Value

Returns this object as a set of nested maps the values are completely unwrapped and don't contain 'Value' objects.

Type Parameters:

K - the type parameter

V - the type parameter

Returns:

a nested Map or null if the operation doesn't make sense (i.e. on a single valued object or list)

toJavaObject

@Nullable
public <R> R toJavaObject()

Description copied from interface: Value

Returns the underlying storage value for this type.

Returns:

the underlying Java object

toJsonString

@NotNull
public @NotNull String toJsonString()

Description copied from interface: Value

Convert this to a Dollar JsonObject

Returns:

this as a JsonObject

toList

@NotNull
public @NotNull com.google.common.collect.ImmutableList<Object> toList()

Description copied from interface: Value

Converts this to a list of value objects such as you would get from $(). Only really useful for collection types.

Returns:

a list of vars.

toNumber

@NotNull
public @NotNull Number toNumber()

Description copied from interface: Value

toNumber number.

Returns:

the number

toStrings

public com.google.common.collect.ImmutableList<String> toStrings()

Description copied from interface: Value

Returns this object as a list of string values or null if this is not applicable.

Returns:

a list of toStrings

toVarList

@NotNull
public @NotNull com.google.common.collect.ImmutableList<Value> toVarList()

Description copied from interface: Value

Converts this to a list of vars. Only really useful for collection types.

Returns:

a list of vars.

toVarMap

@NotNull
public @NotNull com.google.common.collect.ImmutableMap<Value,Value> toVarMap()

Description copied from interface: Value

$ map.

Returns:

an immutable map

toYaml

@NotNull
public @NotNull String toYaml()

Description copied from interface: Value

$ map.

Returns:

the immutable map

truthy

public boolean truthy()

Description copied from interface: Value

Is truthy, i.e. if numeric then non zero, if a string,list or map then not empty etc.

Returns:

if this object is more true than false

compareTo

public int compareTo(@NotNull
                     @NotNull Value o)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDollar

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractDollar