omero

Class rtypes

java.lang.Object

omero.rtypes

public abstract class rtypes
extends Object

Abstract class similar to Arrays or Collections which is responsible for creating RTypes from static factory methods. Where possible, factory methods return cached values (the fly-weight pattern) such that rbool(true) == rbool(true) might hold true. This class is fairly non-traditional Java and instead is more like a Python module or static methods in C++ to keep the three language bindings fairly in step.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	rtypes.Conversion SPI-style interface which helps the omero server to properly convert omero.RType objects into Java-native objects for use in Hibernate.
static class	rtypes.RTypeObjectFactoryRegistry

Constructor Summary

Constructors

Constructor and Description
rtypes()

Method Summary

Modifier and Type	Method and Description
static omero.RArray	rarray(Collection<omero.RType> val)
static omero.RArray	rarray(omero.RType... val)
static omero.RBool	rbool(boolean val)
static omero.RClass	rclass(String val)
static omero.RDouble	rdouble(double val)
static omero.RFloat	rfloat(float val)
static omero.RInt	rint(int val)
static omero.RInternal	rinternal(omero.Internal val)
static omero.RList	rlist(Collection<omero.RType> val)
static omero.RList	rlist(omero.RType... val)
static omero.RLong	rlong(long val)
static omero.RMap	rmap()
static omero.RMap	rmap(Map<String,omero.RType> val)
static omero.RMap	rmap(String key, omero.RType val)
static omero.RObject	robject(omero.model.IObject val)
static omero.RSet	rset(Collection<omero.RType> val)
static omero.RSet	rset(omero.RType... val)
static omero.RString	rstring(String val)
static omero.RTime	rtime_max()
static omero.RTime	rtime_min()
static omero.RTime	rtime_str(String tstr)
static omero.RTime	rtime(Date date)
static omero.RTime	rtime(long val)
static omero.RType	rtype(Object obj) Attempts to dispatch to the other omero.rtypes.* static methods to create a proper RType subclass by checking the type of the input.
static Object	unwrap(omero.RType value) Descends into data structures unwrapping all RType objects as it goes.
static Object	unwrap(omero.RType value, Map<omero.RType,Object> cache) Descends into data structures wrapping all elements as it goes.
protected static void	unwrapCollection(Collection<omero.RType> rtypes, Collection<Object> rv, Map<omero.RType,Object> cache)
static omero.RType	wrap(Object value) Descends into data structures wrapping all elements as it goes.
static omero.RType	wrap(Object value, Map<Object,omero.RType> cache) Descends into data structures wrapping all elements as it goes.

Methods inherited from class java.lang.Object

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

Constructor Detail

rtypes

public rtypes()

Method Detail

rtype

public static omero.RType rtype(Object obj)

Attempts to dispatch to the other omero.rtypes.* static methods to create a proper RType subclass by checking the type of the input. If null is given, null is returned. Otherwise, where possible an RType is returned, else ClientError is thrown.

wrap

public static omero.RType wrap(Object value)

Descends into data structures wrapping all elements as it goes. Limitation: All map keys will be converted to strings! Calls wrap(Object, Map) with a new cache argument.

Parameters:

value - the value to wrap

Returns:

the wrapped value

wrap

public static omero.RType wrap(Object value,
                               Map<Object,omero.RType> cache)

Descends into data structures wrapping all elements as it goes. Limitation: All map keys will be converted to strings! The cache argument is used to prevent cycles.

Parameters:

value - the value to wrap

cache - a cache of wrapped values (to be expanded by misses)

Returns:

the wrapped value

Throws:

ClientError - if all else fails.

unwrap

public static Object unwrap(omero.RType value)

Descends into data structures unwrapping all RType objects as it goes. Limitation: RArrays are turned into List instances! Calls unwrap(RType, Map) with a new cache argument.

Parameters:

value - the wrapped value

Returns:

the value unwrapped

unwrap

public static Object unwrap(omero.RType value,
                            Map<omero.RType,Object> cache)

Descends into data structures wrapping all elements as it goes. Limitation: RArrays are turned into List instances! The cache argument is used to prevent cycles.

Parameters:

value - the wrapped value

cache - a cache of unwrapped values (to be expanded by misses)

Returns:

the value unwrapped

unwrapCollection

protected static void unwrapCollection(Collection<omero.RType> rtypes,
                                       Collection<Object> rv,
                                       Map<omero.RType,Object> cache)

rbool

public static omero.RBool rbool(boolean val)

rdouble

public static omero.RDouble rdouble(double val)

rfloat

public static omero.RFloat rfloat(float val)

rint

public static omero.RInt rint(int val)

rlong

public static omero.RLong rlong(long val)

rtime

public static omero.RTime rtime(long val)

rtime

public static omero.RTime rtime(Date date)

rtime_min

public static omero.RTime rtime_min()

rtime_max

public static omero.RTime rtime_max()

rtime_str

public static omero.RTime rtime_str(String tstr)

rinternal

public static omero.RInternal rinternal(omero.Internal val)

robject

public static omero.RObject robject(omero.model.IObject val)

rclass

public static omero.RClass rclass(String val)

rstring

public static omero.RString rstring(String val)

rarray

public static omero.RArray rarray(omero.RType... val)

rarray

public static omero.RArray rarray(Collection<omero.RType> val)

rlist

public static omero.RList rlist(omero.RType... val)

rlist

public static omero.RList rlist(Collection<omero.RType> val)

rset

public static omero.RSet rset(omero.RType... val)

rset

public static omero.RSet rset(Collection<omero.RType> val)

rmap

public static omero.RMap rmap()

rmap

public static omero.RMap rmap(Map<String,omero.RType> val)

rmap

public static omero.RMap rmap(String key,
                              omero.RType val)