gololang

Class GoloStruct

java.lang.Object

gololang.GoloStruct

All Implemented Interfaces:

Iterable<Tuple>

public abstract class GoloStruct
extends Object
implements Iterable<Tuple>

Base class for Golo structure objects.

This class defines common behavior. Golo structure classes are final subclasses of this one.

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	members The array of member names, initialized in Golo structure classes constructors.

Constructor Summary

Constructors

Constructor and Description
GoloStruct() Constructor that does nothing beyond calling super().

Method Summary

Modifier and Type	Method and Description
abstract GoloStruct	copy() Makes a shallow copy.
abstract GoloStruct	frozenCopy() Makes a shallow frozen copy where any member value modification attempt will fail with an IllegalStateException.
abstract Object	get(String member) Gets a member value by name.
abstract boolean	isFrozen() Tells whether the instance is frozen or not.
Iterator<Tuple>	iterator() Provides an iterator over the structure.
Tuple	members() Gets the member names as a tuple of strings.
abstract GoloStruct	set(String member, Object value) Sets a member value by name.
abstract Tuple	values() Gets the current values, in order of member declaration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

members

protected String[] members

The array of member names, initialized in Golo structure classes constructors.

Constructor Detail

GoloStruct

public GoloStruct()

Constructor that does nothing beyond calling super().

Method Detail

isFrozen

public abstract boolean isFrozen()

Tells whether the instance is frozen or not.

Returns:

true if frozen, false otherwise.

members

public Tuple members()

Gets the member names as a tuple of strings.

Returns:

a tuple of member names.

values

public abstract Tuple values()

Gets the current values, in order of member declaration.

Returns:

a tuple with the current values.

get

public abstract Object get(String member)

Gets a member value by name.

Parameters:

member - the member name.

Returns:

the member value.

Throws:

IllegalArgumentException - if there is no such member member.

set

public abstract GoloStruct set(String member,
                               Object value)

Sets a member value by name.

Parameters:

member - the member name.

value - the value.

Returns:

this instance.

Throws:

IllegalArgumentException - if there is no such member member.

copy

public abstract GoloStruct copy()

Makes a shallow copy.

Returns:

a copy of this structure.

frozenCopy

public abstract GoloStruct frozenCopy()

Makes a shallow frozen copy where any member value modification attempt will fail with an IllegalStateException.

Returns:

a copy of this structure.

iterator

public Iterator<Tuple> iterator()

Provides an iterator over the structure.

Each value is a 2-elements tuple [member, value].

Specified by:

iterator in interface Iterable<Tuple>

Returns:

an iterator.