com.stevewedig.blog.symbol

Interface SymbolSchema

public interface SymbolSchema

Validates SymbolMaps or any other set of symbols by checking required and optional symbols.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<Symbol<?>>	optionalSymbols() Just the optional symbols in the schema.
com.google.common.collect.ImmutableSet<Symbol<?>>	requiredSymbols() Just the required symbols in the schema.
com.google.common.collect.ImmutableSet<Symbol<?>>	symbols() All of the symbols in the schema.
void	validate(Iterable<Symbol<?>> symbols) Validate that required symbols are provided and that the provided symbols are all expected.
void	validate(Set<Symbol<?>> symbols) Validate that required symbols are provided and that the provided symbols are all expected.
void	validate(Symbol<?>... symbols) Validate that required symbols are provided and that the provided symbols are all expected.
void	validate(SymbolMap map) Validate the map's symbols, ensuring that required symbols are provided and that the provided symbols are all expected.
SymbolSchema	withOptional(Symbol<?>... optionalSymbols) Create a schema with the addition of the optionalSymbols, for use in creating schemas via SymbolLib.schema(requiredSymbols...).withOptional(optionalSymbols...).

Method Detail

withOptional

SymbolSchema withOptional(Symbol<?>... optionalSymbols)

Create a schema with the addition of the optionalSymbols, for use in creating schemas via SymbolLib.schema(requiredSymbols...).withOptional(optionalSymbols...).

symbols

com.google.common.collect.ImmutableSet<Symbol<?>> symbols()

All of the symbols in the schema.

requiredSymbols

com.google.common.collect.ImmutableSet<Symbol<?>> requiredSymbols()

Just the required symbols in the schema.

optionalSymbols

com.google.common.collect.ImmutableSet<Symbol<?>> optionalSymbols()

Just the optional symbols in the schema.

validate

void validate(Symbol<?>... symbols)
              throws InvalidSymbols

Validate that required symbols are provided and that the provided symbols are all expected.

Throws:

InvalidSymbols

validate

void validate(Iterable<Symbol<?>> symbols)
              throws InvalidSymbols

Validate that required symbols are provided and that the provided symbols are all expected.

Throws:

InvalidSymbols

validate

void validate(Set<Symbol<?>> symbols)
              throws InvalidSymbols

Validate that required symbols are provided and that the provided symbols are all expected.

Throws:

InvalidSymbols

validate

void validate(SymbolMap map)
              throws InvalidSymbols

Validate the map's symbols, ensuring that required symbols are provided and that the provided symbols are all expected.

Throws:

InvalidSymbols