Uses of Interface
com.funnelback.filter.api.documents.FilterableDocument

Packages that use FilterableDocument

Package	Description
com.funnelback.filter.api	This holds the public API which clients are expected to use for filtering.
com.funnelback.filter.api.documents
com.funnelback.filter.api.filters

Uses of FilterableDocument in com.funnelback.filter.api

Methods in com.funnelback.filter.api with parameters of type FilterableDocument

Modifier and Type	Method	Description
static FilterResult	FilterResult.of(FilterableDocument filteredDocument)	Returned by a filter when it has filtered a document returning a single document.

Method parameters in com.funnelback.filter.api with type arguments of type FilterableDocument

Modifier and Type	Method	Description
static FilterResult	FilterResult.of(java.util.Collection<? extends FilterableDocument> filteredDocuments)	Returned by a filter when it has filtered a document into many documents.

Uses of FilterableDocument in com.funnelback.filter.api.documents

Subinterfaces of FilterableDocument in com.funnelback.filter.api.documents

Modifier and Type	Interface	Description
interface	BytesDocument	A raw byte document.
interface	StringDocument	A filterable String Document

Methods in com.funnelback.filter.api.documents that return FilterableDocument

Modifier and Type	Method	Description
FilterableDocument	FilterableDocument.cloneWithDocumentType(DocumentType documentType)	Creates a clone of the document with the given document type.
FilterableDocument	FilterableDocument.cloneWithMetadata(com.google.common.collect.ListMultimap<java.lang.String,java.lang.String> metadata)	Gets a clone of the document with the given metadata.
FilterableDocument	FilterableDocument.cloneWithURI(java.net.URI uri)	Gets a clone of the document with a different URI.

Methods in com.funnelback.filter.api.documents with parameters of type FilterableDocument

Modifier and Type	Method	Description
static BytesDocument	BytesDocument.from(FilterableDocument filterableDocument)	Converts a FilterableDocument into a RawFilterableDocument
static java.util.Optional<StringDocument>	StringDocument.from(FilterableDocument filterableDocument)	Attempts to create a StingDocument from the given document.
static StringDocument	StringDocument.from(FilterableDocument filterableDocument, DocumentType documentType, java.lang.String content)	Constructs a StringDocument from a FilterableDocument, with the given mimeType and content.
static java.nio.charset.Charset	StringDocument.getOrGuessCharset(FilterableDocument filterableDocument)	Gets the charset of the filterableDocument, if the charset is unknown this guesses the charset by looking at the raw bytes.

Uses of FilterableDocument in com.funnelback.filter.api.filters

Methods in com.funnelback.filter.api.filters with parameters of type FilterableDocument

Modifier and Type	Method	Description
default FilterResult	BytesDocumentFilter.filter(FilterableDocument document, FilterContext context)	Filter method responsible for calling #canFilter(FilterableDocument, FilterContext) and BytesDocumentFilter.filterAsBytesDocument(BytesDocument, FilterContext)
FilterResult	Filter.filter(FilterableDocument document, FilterContext context)	Filter a document.
default FilterResult	StringDocumentFilter.filter(FilterableDocument document, FilterContext context)	Filter method responsible for calling #canFilter(FilterableDocument, FilterContext) and StringDocumentFilter.filterAsStringDocument(StringDocument, FilterContext)

Constructors in com.funnelback.filter.api.filters with parameters of type FilterableDocument

Constructor	Description
FilterException(FilterableDocument documentBeingFiltered, java.lang.String message)
FilterException(FilterableDocument documentBeingFiltered, java.lang.String message, java.lang.Throwable cause)