hu.scelightapi.util

Interface IStructView

All Known Subinterfaces:

IAttributesEvents, IBaseUnitEvent, ICameraSaveEvent, ICameraUpdateEvent, IChatEvent, ICmdEvent, IControlGroupUpdateEvent, IDelta, IDetails, IEvent, IGameDescription, IGameUserLeaveEvent, IHeader, IInitData, ILobbyState, IMsgEvent, IPingEvent, IPlayer, IPlayerLeaveEvent, IPlayerSetupEvent, IPlayerStatsEvent, IResourceRequestEvent, IResourceRequestFulfillEvent, IResourceTradeEvent, ISelectionDeltaEvent, ISlot, ISlotDescription, ISubgroup, ITargetPoint, ITargetPoint, ITargetUnit, IToon, IUnitBornEvent, IUnitDoneEvent, IUnitInitEvent, IUpgradeEvent, IUserInitData

public interface IStructView

Interface modeling a class which has a source key-value structure (a Map) where keys are Strings, and provides easy access to its content.

Author:

Andras Belicza

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(java.lang.String name) Returns the value of the field specified by its name.
<T> T	get(java.lang.String[] path) Returns the value for the field specified by its path.
java.util.Map<java.lang.String,java.lang.Object>	getStruct() Returns the source structure.

Method Detail

get

<T> T get(java.lang.String name)

Returns the value of the field specified by its name.

Type Parameters:

T - (expected) type of the value

Parameters:

name - name of the field

Returns:

the value of the field specified by its name

get

<T> T get(java.lang.String[] path)

Returns the value for the field specified by its path.

This method returns a value acquired in n steps (where n is the number of path elements).
The first step is executed on this, and the step result is the value returned by get(String) for the first path element.
The result of the i^th step is the value returned by get(String) called on the result of the i-1 ^th step which must be of type IStructView.
The return value of the method is the result of the n^th step.

If the result of any steps is null, then null is returned.

Type Parameters:

T - (expected) type of the value

Parameters:

path - path to the field

Returns:

the value of the field specified by its path

getStruct

java.util.Map<java.lang.String,java.lang.Object> getStruct()

Returns the source structure.

Returns:

the source structure