ome.smuggler.core.types

Class ValueParserFactory

java.lang.Object

ome.smuggler.core.types.ValueParserFactory

public class ValueParserFactory
extends java.lang.Object

Methods to instantiate valid values of a certain type from their string representation.

Constructor Summary

Constructors

Constructor and Description
ValueParserFactory()

Method Summary

Modifier and Type	Method and Description
static util.object.Either<java.lang.String,DatasetId>	datasetId(java.lang.String value) Creates a dataset ID from a positive integer.
static util.object.Either<java.lang.String,Email>	email(java.lang.String value) Creates an email from its string representation.
static <T> util.object.Either<java.lang.String,T>	label(java.lang.String errorMsgPrefix, util.object.Either<java.lang.String,T> value) Prefixes the error message (i.e.
static util.object.Either<java.lang.String,java.time.Duration>	millis(java.lang.String value) Parses the string representation of a positive integer as a Duration in milliseconds.
static util.object.Either<java.lang.String,java.net.URI>	omeroUri(java.lang.String host, java.lang.String port) Creates a URI from host and port components: the returned URI will be of the form omero://host:port/.
static util.object.Either<java.lang.String,PositiveN>	positiveInt(java.lang.String value) Creates a positive natural from its string representation.
static util.object.Either<java.lang.String,ScreenId>	screenId(java.lang.String value) Creates a screen ID from a positive integer.
static util.object.Either<java.lang.String,java.lang.String>	string(java.lang.String value) Parses a string of length at least one.
static util.object.Either<java.lang.String,java.net.URI>	targetUri(java.lang.String value) Creates a URI from the target field in the import request.
static util.object.Either<java.lang.String,TextAnnotation>	textAnnotation(java.lang.String... xs) Creates a text annotation from its string representation.
static util.object.Either<java.lang.String,java.net.URI>	uri(java.lang.String value) Creates a URI from its string representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueParserFactory

public ValueParserFactory()

Method Detail

datasetId

public static util.object.Either<java.lang.String,DatasetId> datasetId(java.lang.String value)

Creates a dataset ID from a positive integer.

Parameters:

value - string representation of a positive integer.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

screenId

public static util.object.Either<java.lang.String,ScreenId> screenId(java.lang.String value)

Creates a screen ID from a positive integer.

Parameters:

value - string representation of a positive integer.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

email

public static util.object.Either<java.lang.String,Email> email(java.lang.String value)

Creates an email from its string representation.

Parameters:

value - string representation of an email address, e.g. x@y.edu.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

positiveInt

public static util.object.Either<java.lang.String,PositiveN> positiveInt(java.lang.String value)

Creates a positive natural from its string representation.

Parameters:

value - string representation of a positive integer.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

textAnnotation

public static util.object.Either<java.lang.String,TextAnnotation> textAnnotation(java.lang.String... xs)

Creates a text annotation from its string representation.

Parameters:

xs - a pair of strings: a namespace followed by the annotation content.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

uri

public static util.object.Either<java.lang.String,java.net.URI> uri(java.lang.String value)

Creates a URI from its string representation.

Parameters:

value - string representation of a URI, e.g. /some/file.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

targetUri

public static util.object.Either<java.lang.String,java.net.URI> targetUri(java.lang.String value)

Creates a URI from the target field in the import request.

Parameters:

value - the target field.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

omeroUri

public static util.object.Either<java.lang.String,java.net.URI> omeroUri(java.lang.String host,
                                                                         java.lang.String port)

Creates a URI from host and port components: the returned URI will be of the form omero://host:port/.

Parameters:

host - the host component of the URI.

port - the port component of the URI.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

string

public static util.object.Either<java.lang.String,java.lang.String> string(java.lang.String value)

Parses a string of length at least one.

Parameters:

value - a string of length at least one.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

millis

public static util.object.Either<java.lang.String,java.time.Duration> millis(java.lang.String value)

Parses the string representation of a positive integer as a Duration in milliseconds.

Parameters:

value - a string representation of a positive.

Returns:

either a (right) value or an error message (left) detailing why the value could not be instantiated.

label

public static <T> util.object.Either<java.lang.String,T> label(java.lang.String errorMsgPrefix,
                                                               util.object.Either<java.lang.String,T> value)

Prefixes the error message (i.e. any left value) with the specified label p so that if e is the original message, the new message will be of the form p:e.

Type Parameters:

T - any type.

Parameters:

errorMsgPrefix - the string to prefix to the error message.

value - the input to prefix in the case it's a left value.

Returns:

the prefixed error message if the input either is a left value; otherwise the input's right value as is.

Throws:

java.lang.NullPointerException - if any argument is null.