Module com.io7m.jsx.combinators

Package com.io7m.jsx.combinators

Class JSXCombinators

java.lang.Object

com.io7m.jsx.combinators.JSXCombinators

public final class JSXCombinators
extends Object

Convenient combinators for validating and extracting data from S-expressions.

Method Summary

Modifier and Type	Method	Description
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionListType>	anyList(SExpressionType e)	Assert that the given expression is a list.
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionQuotedStringType>	anyOfQuotedString(SExpressionType e, io.vavr.collection.List<String> texts)	Assert that the given expression is a symbol with any of the given names.
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionSymbolType>	anyOfSymbol(SExpressionType e, io.vavr.collection.List<String> names)	Assert that the given expression is a symbol with any of the given names.
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionQuotedStringType>	anyQuotedString(SExpressionType e)	Assert that the given expression is a quoted string.
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionSymbolType>	anySymbol(SExpressionType e)	Assert that the given expression is a symbol.
static <T> io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,T>	atListElement(SExpressionListType e, int index, Function<SExpressionType,io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,T>> receiver)	Retrieve a value from a list.
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionQuotedStringType>	exactQuotedString(SExpressionType e, String name)	Assert that the given expression is a quoted string with the given name.
static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionSymbolType>	exactSymbol(SExpressionType e, String name)	Assert that the given expression is a symbol with the given name.
static <T> io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,io.vavr.collection.List<T>>	listMap(SExpressionListType e, Function<SExpressionType,io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,T>> receiver)	Apply a validation function to each element of the given list expression.

Methods inherited from class java.lang.Object

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

Method Detail

atListElement

public static <T> io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,T> atListElement(SExpressionListType e,
                                                                                                              int index,
                                                                                                              Function<SExpressionType,io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,T>> receiver)

Retrieve a value from a list.

Type Parameters:

T - The type of returned values

Parameters:

e - The list expression

index - The list index

receiver - The receiver

Returns:

A validation value based upon the result of applying receiver to the list element, or an invalid value if the list index is out of range

exactSymbol

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionSymbolType> exactSymbol(SExpressionType e,
                                                                                                                            String name)

Assert that the given expression is a symbol with the given name.

Parameters:

e - The expression

name - The symbol name

Returns:

The symbol, or an invalid value if e is not a symbol with the given name

anyOfSymbol

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionSymbolType> anyOfSymbol(SExpressionType e,
                                                                                                                            io.vavr.collection.List<String> names)

Assert that the given expression is a symbol with any of the given names.

Parameters:

e - The expression

names - The symbol names

Returns:

The symbol, or an invalid value if e is not a symbol with the given name

exactQuotedString

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionQuotedStringType> exactQuotedString(SExpressionType e,
                                                                                                                                        String name)

Assert that the given expression is a quoted string with the given name.

Parameters:

e - The expression

name - The quoted string name

Returns:

The quoted string, or an invalid value if e is not a quoted string with the given name

anyOfQuotedString

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionQuotedStringType> anyOfQuotedString(SExpressionType e,
                                                                                                                                        io.vavr.collection.List<String> texts)

Assert that the given expression is a symbol with any of the given names.

Parameters:

e - The expression

texts - The quoted string texts

Returns:

The symbol, or an invalid value if e is not a symbol with the given name

anySymbol

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionSymbolType> anySymbol(SExpressionType e)

Assert that the given expression is a symbol.

Parameters:

e - The expression

Returns:

The symbol, or an invalid value if e is not a symbol

anyList

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionListType> anyList(SExpressionType e)

Assert that the given expression is a list.

Parameters:

e - The expression

Returns:

The list, or an invalid value if e is not a list

anyQuotedString

public static io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,SExpressionQuotedStringType> anyQuotedString(SExpressionType e)

Assert that the given expression is a quoted string.

Parameters:

e - The expression

Returns:

The quoted string, or an invalid value if e is not a quoted string

listMap

public static <T> io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,io.vavr.collection.List<T>> listMap(SExpressionListType e,
                                                                                                                                 Function<SExpressionType,io.vavr.control.Validation<io.vavr.collection.List<JSXValidationErrorType>,T>> receiver)

Apply a validation function to each element of the given list expression.

Type Parameters:

T - The type of returned elements

Parameters:

e - The list expression

receiver - The validation function

Returns:

A valid value if all of the elements were validated, otherwise an invalid value