Package se.conciliate.extensions.documents

Class InputDescriptor.UrlInputBuilder

java.lang.Object

se.conciliate.extensions.documents.InputDescriptor.UrlInputBuilder

Enclosing class:

InputDescriptor<T extends MetaData>

public static final class InputDescriptor.UrlInputBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected InputDescriptor.UrlDescriptor	descriptor

Method Summary

Modifier and Type	Method	Description
InputDescriptor.UrlInputBuilder	addSupportedSchema(String schema)
InputDescriptor.UrlInputBuilder	addUrlPrefix(InputDescriptor.UrlPrefix prefix)
InputDescriptor.UrlDescriptor	build()
InputDescriptor.UrlInputBuilder	connectTo(MetaDataType<?> t, BiFunction<MetaData<?>,MetaData<?>,MetaData<?>> onChange)	“Connects the InputDescriptor built by this builder to the given MetaDataType so that when metadata for the InputDescriptor built by this builder is changed, the given BiFunction is applied (called) with both the changed metadata and the connected metadata.
InputDescriptor.UrlInputBuilder	setPrefixes(List<InputDescriptor.UrlPrefix> prefixes)
InputDescriptor.UrlInputBuilder	setSupportedSchemas(List<String> schemas)
InputDescriptor.UrlInputBuilder	validator(Validator<MetaData.UrlValue> validator)	Puts a validator on the descriptor.

Methods inherited from class java.lang.Object

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

Field Details

descriptor

protected InputDescriptor.UrlDescriptor descriptor

Method Details

addSupportedSchema

public InputDescriptor.UrlInputBuilder addSupportedSchema(String schema)

setSupportedSchemas

public InputDescriptor.UrlInputBuilder setSupportedSchemas(List<String> schemas)

addUrlPrefix

public InputDescriptor.UrlInputBuilder addUrlPrefix(InputDescriptor.UrlPrefix prefix)

setPrefixes

public InputDescriptor.UrlInputBuilder setPrefixes(List<InputDescriptor.UrlPrefix> prefixes)

connectTo

public InputDescriptor.UrlInputBuilder connectTo(MetaDataType<?> t,
 BiFunction<MetaData<?>,MetaData<?>,MetaData<?>> onChange)

“Connects the InputDescriptor built by this builder to the given MetaDataType so that when metadata for the InputDescriptor built by this builder is changed, the given BiFunction is applied (called) with both the changed metadata and the connected metadata. The connected metadata is then updated with the result of the BiFunction. This means that one metadata can change as a result of another metadata changing. For example, one can connect the URL metadata to an Image metadata so that when the URL of a document changes from “http://example.com/mydoc.pdf” to “http://example.com/mydoc.docx” the icon of the document changes from a pdf-icon to a docx-icon.”

Parameters:

t - The connected MetaDataType.

onChange - The two metadata that will be connected and changed as a result of the other metadata changing.

Returns:

Returns this UrlInputBuilder

validator

public InputDescriptor.UrlInputBuilder validator(Validator<MetaData.UrlValue> validator)

Puts a validator on the descriptor. The validator will be called on some arbitrary non-ui thread and must therefore be thread safe. The validator takes a string to validate. The validator returns:

• ValidationResult.success() if validation succeeds
• ValidationResult.error(String) if validation fails and is binding (data cannot be saved)
• ValidationResult.success() if validation fails and is non-binding (data can be saved)

Parameters:

validator - A validator or null to use no validator.

Returns:

This builder for chaining.

build

public InputDescriptor.UrlDescriptor build()