org.mule.common.metadata.parser.json

Class OptionalType

java.lang.Object

org.mule.common.metadata.parser.json.OptionalType

All Implemented Interfaces:

JSONType

public class OptionalType
extends Object
implements JSONType

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.common.metadata.parser.json.JSONType

JSONType.BooleanType, JSONType.DoubleType, JSONType.Empty, JSONType.Everything, JSONType.IntegerType, JSONType.NumberType, JSONType.StringType

Constructor Summary

Constructors

Constructor and Description
OptionalType(JSONType t)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object obj) The central method of JSONType; the type encompasses the values for which contains returns true.
String	explain(Object obj) Returns a non-null String explanation, suitable for display to a user, explaining why the given object fails to conform to the JSONType's contains method.
boolean	isJSONArray()
boolean	isJSONObject()
boolean	isJSONPointer()
boolean	isJSONPrimitive()
boolean	isOptional()

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalType

public OptionalType(JSONType t)

Method Detail

contains

public boolean contains(Object obj)

Description copied from interface: JSONType

The central method of JSONType; the type encompasses the values for which contains returns true.

Specified by:

contains in interface JSONType

Returns:

trueif the given Object satisfies the type, false otherwise.

explain

public String explain(Object obj)

Description copied from interface: JSONType

Returns a non-null String explanation, suitable for display to a user, explaining why the given object fails to conform to the JSONType's contains method.

Specified by:

explain in interface JSONType

Returns:

an explanatory string if contains(arg) is false, or null if contains(arg) is true.

isOptional

public boolean isOptional()

Specified by:

isOptional in interface JSONType

Returns:

true if the type will accept "missing" (i.e. null) values, false otherwise.

isJSONPrimitive

public boolean isJSONPrimitive()

Specified by:

isJSONPrimitive in interface JSONType

isJSONArray

public boolean isJSONArray()

Specified by:

isJSONArray in interface JSONType

isJSONObject

public boolean isJSONObject()

Specified by:

isJSONObject in interface JSONType

isJSONPointer

public boolean isJSONPointer()

Specified by:

isJSONPointer in interface JSONType