hu.elte.txtuml.api.model

Class API

java.lang.Object

hu.elte.txtuml.api.model.API

@External
public abstract class API
extends java.lang.Object

Provides methods to communicate with a txtUML model safely from the outside world.

Represents: no model element, can only be used from outside the model

Usage:

Cannot be used in a model, call its static methods from any outside code (it is always thread-safe).

See the documentation of Model for an overview on modeling in JtxtUML.

Constructor Summary

Constructors

Constructor and Description
API()

Method Summary

Modifier and Type	Method and Description
static <E> Any<E>	collect(E... elements) Collects the given elements to a new txtUML API collection.
static <E,C extends GeneralCollection<E>,C2 extends GeneralCollection<?>> C	collectIn(java.lang.Class<C2> collectionType, E... elements) Collects the given elements to a new txtUML API collection of the given type.
static void	log(java.lang.String message) Logs a message.
static void	logError(java.lang.String message) Logs an error message.
static void	send(Signal signal, ModelClass target) Asynchronously sends the specified signal to the specified target object.

Methods inherited from class java.lang.Object

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

Constructor Detail

API

public API()

Method Detail

send

public static void send(Signal signal,
                        ModelClass target)

Asynchronously sends the specified signal to the specified target object.

Does not check whether the target object is deleted, it is only checked when the signal arrives to the object.

Use Action.send(Signal, ModelClass) instead of this method from inside the model.

Parameters:

signal - the signal object to send

target - the model object which will receive the signal

Throws:

java.lang.NullPointerException - if target is null

log

public static void log(java.lang.String message)

Logs a message.

Use Action.log(String) instead of this method from inside the model.

Parameters:

message - the message to be logged

logError

public static void logError(java.lang.String message)

Logs an error message.

Use Action.logError(String) instead of this method from inside the model.

Parameters:

message - the error message to be logged

collect

@SafeVarargs
public static <E> Any<E> collect(E... elements)

Collects the given elements to a new txtUML API collection. This method creates the most general collection type, the unordered non-unique 0..* collection, Any.

Use Action.collect(Object...) instead of this method from inside the model.

Parameters:

elements - the elements to collect

Returns:

the newly created collection that contains the specified elements

collectIn

@SafeVarargs
public static <E,C extends GeneralCollection<E>,C2 extends GeneralCollection<?>> C collectIn(java.lang.Class<C2> collectionType,
                                                                                                          E... elements)

Collects the given elements to a new txtUML API collection of the given type. If the specified collection type is ordered, it will contain the elements in the provided order. If it is unique and multiple equal elements are given, only the first will be contained in the collection.

Use Action.collectIn(Class, Object...) instead of this method from inside the model.

Parameters:

collectionType - the type of the collection to create; must be a txtUML API collection

elements - the elements to collect

Returns:

the newly created collection that contains the specified elements