com.kapowtech.robosuite.api.java.rql.construct

Class Environments

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<Environment>

com.kapowtech.robosuite.api.java.rql.construct.Environments

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Environment>, java.util.Collection<Environment>, java.util.List<Environment>

public final class Environments
extends java.util.AbstractList<Environment>
implements java.io.Serializable

A robot is always run using a list of environments. The environments affect the execution of the robot and determines how extracted objects are stored, how robot generated messages are handled, etc.

The environment list should contain at most one of each type of environment: That is:

• Common Robot Environment
• Robot Info Environment
• Storage Environment Environment
• Message Environment

Additionally, the robot must contain a Query Environment, if the robot takes query parameters.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
Environments() Creates a new empty Environments.
Environments(Environment environment) Creates an Enviroments object holding one Environment.
Environments(java.util.List<Environment> environments) Creates an Enviroments object from a list of Environment objects.

Method Summary

Modifier and Type	Method and Description
void	add(int index, Environment element)
Environment	get(int index) Returns the Environment at the specified position in this list.
Environment	getEnvironment(int index) Returns the Environment at the specified position in this list.
Environment	getEnvironmentByClass(java.lang.Class environmentClass) Returns the first environment in the list that is of a specific class, or null if no such environment was found.
Environment	remove(int index)
int	size() Returns the number of environments in this collection.

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Environments

public Environments()

Creates a new empty Environments.

Environments

public Environments(Environment environment)

Creates an Enviroments object holding one Environment.

Parameters:

environment - an environment to put into the constructed object.

Environments

public Environments(java.util.List<Environment> environments)

Creates an Enviroments object from a list of Environment objects.

Parameters:

environments - a list of Environment objects.

Method Detail

get

public Environment get(int index)

Returns the Environment at the specified position in this list.

Specified by:

get in interface java.util.List<Environment>

Specified by:

get in class java.util.AbstractList<Environment>

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

java.lang.IndexOutOfBoundsException - if the given index is out of range (index < 0 || index >= size()).

getEnvironmentByClass

public Environment getEnvironmentByClass(java.lang.Class environmentClass)

Returns the first environment in the list that is of a specific class, or null if no such environment was found.

Parameters:

environmentClass - the class to look for

Returns:

the first environment in the list that is of a specific class, or null if no such environment was found.

getEnvironment

public Environment getEnvironment(int index)

Returns the Environment at the specified position in this list. This returns the same object as the get method, but it is allready cast to the correct type.

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

java.lang.IndexOutOfBoundsException - if the given index is out of range (index < 0 || index >= size()).

size

public int size()

Returns the number of environments in this collection. If the collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.Collection<Environment>

Specified by:

size in interface java.util.List<Environment>

Specified by:

size in class java.util.AbstractCollection<Environment>

Returns:

the number of elements in this collection.

add

public void add(int index,
                Environment element)

Specified by:

add in interface java.util.List<Environment>

Overrides:

add in class java.util.AbstractList<Environment>

remove

public Environment remove(int index)

Specified by:

remove in interface java.util.List<Environment>

Overrides:

remove in class java.util.AbstractList<Environment>