Module org.autogui

Package org.autogui.base.mapping

Class GuiReprSet

java.lang.Object

org.autogui.base.mapping.GuiReprSet

All Implemented Interfaces:

GuiRepresentation

public class GuiReprSet
extends Object
implements GuiRepresentation

a composition of representations. if match(GuiMappingContext) matches a member representation, it immediately stops the matching and returns true. the matched member representation will be set to the context

Nested Class Summary

Nested classes/interfaces inherited from interface org.autogui.base.mapping.GuiRepresentation

GuiRepresentation.GuiReprNone, GuiRepresentation.TreeString, GuiRepresentation.TreeStringComposite, GuiRepresentation.TreeStringValue

Field Summary

Fields

Modifier and Type	Field	Description
protected List<GuiRepresentation>	representations

Fields inherited from interface org.autogui.base.mapping.GuiRepresentation

NONE

Constructor Summary

Constructors

Constructor	Description
GuiReprSet()

Method Summary

Modifier and Type	Method	Description
GuiReprSet	add(GuiRepresentation... rs)
boolean	checkAndUpdateSource(GuiMappingContext context)	the class is basically used for matching; so the definition of the method is useless.
Object	fromJson(GuiMappingContext context, Object target, Object json)	create a new value object from the JSON with treating the target as an old value, or update the target with the JSON contents.
GuiReprSet	insert(GuiRepresentation... rs)
boolean	match(GuiMappingContext context)	match the representation with the typeElement of the context, and if succeeded, it sets this representation to the context, and it might create sub-contexts for recursive matches *
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.base.mapping.GuiRepresentation

continueCheckAndUpdateSourceForChildren, fromHumanReadableString, fromJsonWithNamed, isJsonSetter, isTaskRunnerUsedFor, matchAndSetNotifiersAsInit, setNotifiersTree, shutdown, toHumanReadableString, toHumanReadableStringTree, toJsonWithNamed, toStringHeader

Field Details

representations

protected List<GuiRepresentation> representations

Constructor Details

GuiReprSet

public GuiReprSet()

Method Details

add

public GuiReprSet add(GuiRepresentation... rs)

insert

public GuiReprSet insert(GuiRepresentation... rs)

match

public boolean match(GuiMappingContext context)

Description copied from interface: GuiRepresentation

match the representation with the typeElement of the context, and if succeeded, it sets this representation to the context, and it might create sub-contexts for recursive matches *

Specified by:

match in interface GuiRepresentation

Parameters:

context - the context of the repr.

Returns:

the matching result

checkAndUpdateSource

public boolean checkAndUpdateSource(GuiMappingContext context)

the class is basically used for matching; so the definition of the method is useless.

Specified by:

checkAndUpdateSource in interface GuiRepresentation

Parameters:

context - the context of the repr.

Returns:

the representation is updated or not

toJson

public Object toJson(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

convert the source into JSON format

Specified by:

toJson in interface GuiRepresentation

Parameters:

context - a context holds the representation

source - the converted object

Returns:

JSON objects representing the source; String, Number, Boolean, List, Map or null

fromJson

public Object fromJson(GuiMappingContext context,
 Object target,
 Object json)

Description copied from interface: GuiRepresentation

create a new value object from the JSON with treating the target as an old value, or update the target with the JSON contents. the behavior can be varied by each representation, confirmed by GuiRepresentation.isJsonSetter().

Specified by:

fromJson in interface GuiRepresentation

Parameters:

context - a context holds the representation

target - the target object or null

json - JSON objects representing the target String, Number, Boolean, List, Map or null

Returns:

created object from the json, target if provided, or null.

toString

public String toString()

Overrides:

toString in class Object