A

accept(T) - Method in interface org.pfsw.bif.callback.IConsumer

Performs this operation on the given argument.

ALL - Static variable in interface org.pfsw.bif.text.IStringFilter

A predefined filter that matches all strings (but not null).

appendAsJSONString(Appendable) - Method in interface org.pfsw.bif.text.IJSONConvertible

The receiver of this method must append its internal state as JSON string representation to the given buffer.

apply(T) - Method in interface org.pfsw.bif.callback.IFunction

Applies this function to the given argument.

asArray() - Method in interface org.pfsw.bif.text.IStringPair

Returns both strings of this pair in a String array.

asBoolean() - Method in interface org.pfsw.bif.conversion.IBooleanRepresentation

Returns the boolean representation of the implementing object.

asInteger() - Method in interface org.pfsw.bif.conversion.IIntegerRepresentation

Returns the integer representation of the implementing object.

asLong() - Method in interface org.pfsw.bif.conversion.ILongRepresentation

Returns the long representation of the implementing object.

asString(String) - Method in interface org.pfsw.bif.text.IStringPair

Returns the two strings as one string separated by the given separator.

asString() - Method in interface org.pfsw.bif.text.IStringRepresentation

Returns the string representation of the implementing object.

asString() - Method in enum org.pfsw.bif.text.JsonSyntaxElement

 

B

BooleanOperation - Enum in org.pfsw.bif.logic

Just the standard operations for boolean logic.

C

collectObject(Collection<T>, T) - Method in interface org.pfsw.bif.IObjectCollector

Will be called with an object that maybe must be added to the given collection.

ConfigRuntimeException - Exception in org.pfsw.bif.configuration

A generic runtime exception that signals a configuration problem.

ConfigRuntimeException(String, Object...) - Constructor for exception org.pfsw.bif.configuration.ConfigRuntimeException

 

ConfigRuntimeException(Throwable, String, Object...) - Constructor for exception org.pfsw.bif.configuration.ConfigRuntimeException

 

ConfigRuntimeException(Throwable) - Constructor for exception org.pfsw.bif.configuration.ConfigRuntimeException

 

ConfigurationException - Exception in org.pfsw.bif.configuration

An exception that signals problems with configuration of something.

ConfigurationException() - Constructor for exception org.pfsw.bif.configuration.ConfigurationException

 

ConfigurationException(String, Throwable) - Constructor for exception org.pfsw.bif.configuration.ConfigurationException

 

ConfigurationException(String) - Constructor for exception org.pfsw.bif.configuration.ConfigurationException

 

ConfigurationException(Throwable) - Constructor for exception org.pfsw.bif.configuration.ConfigurationException

 

ConfigurationException(String, Object...) - Constructor for exception org.pfsw.bif.configuration.ConfigurationException

 

ConfigurationException(Throwable, String, Object...) - Constructor for exception org.pfsw.bif.configuration.ConfigurationException

 

configure(IConfigSettings) - Method in interface org.pfsw.bif.configuration.IConfigurable

Configure the receiver with the provided settings.

configure(Map<K, V>) - Method in interface org.pfsw.bif.configuration.IConfigurableByMap

Configure the receiver with the data provided by the given map

CONTINUE - Static variable in interface org.pfsw.bif.callback.IProgressListener

The value returned by a listener that signals to continue processing.

ConversionRuntimeException - Exception in org.pfsw.bif.conversion

A runtime exception signaling a conversion problem.

ConversionRuntimeException(String, Object...) - Constructor for exception org.pfsw.bif.conversion.ConversionRuntimeException

 

ConversionRuntimeException(Throwable, String, Object...) - Constructor for exception org.pfsw.bif.conversion.ConversionRuntimeException

 

ConversionRuntimeException(Throwable) - Constructor for exception org.pfsw.bif.conversion.ConversionRuntimeException

 

convert(TSource) - Method in interface org.pfsw.bif.conversion.IObjectConverter

Converts the given source object into the target representation.

convert(T) - Method in interface org.pfsw.bif.conversion.IStringConverter

Converts the given source object into a string representation.

D

dispose() - Method in interface org.pfsw.bif.lifecycle.IDisposable

Get rid of all internal references to other objects.

E

EMPTY_ARRAY - Static variable in interface org.pfsw.bif.text.IStringPair

An immutable empty array of this type.

execute() - Method in interface org.pfsw.bif.execution.IExecutable

Execute the implementor's functionality

F

FIRST_CUSTOM_STATE - Static variable in interface org.pfsw.bif.execution.IServiceStateChangeListener

Any custom state value should be defined as addition of this constant plus any integer value

G

get() - Method in interface org.pfsw.bif.callback.ISupplier

Gets a result.

getBytes(String) - Method in interface org.pfsw.bif.text.ICheckedCharset

Returns the bytes of the given string as array encoded to the charset this instance represents, avoiding the unnecessary exception handling (UnsupportedEncodingException).

getCharset() - Method in interface org.pfsw.bif.text.ICheckedCharset

Returns the corresponding charset object.

getDeclaringClass() - Method in interface org.pfsw.bif.enums.IEnumType

Returns the Class object corresponding to this enum constant's enum type.

getFieldName() - Method in interface org.pfsw.bif.enums.IFieldName

Returns the field name as string.

getName() - Method in interface org.pfsw.bif.text.ICheckedCharset

Returns the pure upper case encoding name (e.g.

getNames() - Method in interface org.pfsw.bif.facet.IReadOnlyNamedValues

Returns all names (maybe empty but never null).

getString1() - Method in interface org.pfsw.bif.text.IStringPair

Returns the first string of this pair.

getString2() - Method in interface org.pfsw.bif.text.IStringPair

Returns the second string of this pair.

getValue(String) - Method in interface org.pfsw.bif.facet.IReadOnlyNamedValues

Returns the value associated with the given name.

H

handleStream(InputStream) - Method in interface org.pfsw.bif.callback.IInputStreamHandler

 

handleStream(OutputStream) - Method in interface org.pfsw.bif.callback.IOutputStreamHandler

 

I

IBasicLifecycle - Interface in org.pfsw.bif.lifecycle

Combines interfaces IInitializable and IDisposable

IBidirectionalConverter<TInternal,TExternal> - Interface in org.pfsw.bif.conversion

A general interface for converters that can do conversion from an internal object representation to an external representation and vice versa.

IBooleanRepresentation - Interface in org.pfsw.bif.conversion

This interface defines the method an object must support, if it wants to represent itself as a boolean.

ICharsets - Interface in org.pfsw.bif.text

Provides constants for the standard character sets that are available in every JRE.

ICheckedCharset - Interface in org.pfsw.bif.text

Specifies the interface of objects that represents a character encoding name that has already been checked if it is supported by the platform.

ICondition - Interface in org.pfsw.bif.logic

Represents a condition independent of its internal complexity.

IConfigSettings - Interface in org.pfsw.bif.configuration

A simple interface for string based key/value pairs that are used to configure something.

IConfigurable - Interface in org.pfsw.bif.configuration

Defines a generic configuration method based on string key/value pairs.

IConfigurableByMap<K,V> - Interface in org.pfsw.bif.configuration

Defines a generic configuration method based on a Map.

IConsumer<T> - Interface in org.pfsw.bif.callback

Can be used like Java 8 java.util.Consumer, but is available for Java 6.

IdentifierGenerationException - Exception in org.pfsw.bif.identifier

General purpose exception for all problems that might occur during identifier generation.

IdentifierGenerationException(String, Object...) - Constructor for exception org.pfsw.bif.identifier.IdentifierGenerationException

 

IdentifierGenerationException(Throwable, String, Object...) - Constructor for exception org.pfsw.bif.identifier.IdentifierGenerationException

 

IDisposable - Interface in org.pfsw.bif.lifecycle

This interface specifies just a dispose() method an object must understand to dispose its internal resources.

IEnumType - Interface in org.pfsw.bif.enums

A general interface that allows to mark enum types and therefore use the interface rather than the enum directly.

IExecutable - Interface in org.pfsw.bif.execution

Defines an execute() method

IFieldName - Interface in org.pfsw.bif.enums

Common interface for enumerations that specify field names.

IFunction<T,R> - Interface in org.pfsw.bif.callback

Can be used like Java 8 java.util.Function, but is available for Java 6.

IInitializable - Interface in org.pfsw.bif.lifecycle

Generic no argument initialization

IInputStreamHandler - Interface in org.pfsw.bif.callback

A callback implementation that can be used to handle the input stream of any process that produces such a stream.

IIntegerRepresentation - Interface in org.pfsw.bif.conversion

This interface defines the method an object must support, if it wants to represent itself as an integer.

IJSONConvertible - Interface in org.pfsw.bif.text

Implementers of this interface are capable of converting themselves into a valid JSON string representation.

ILineProcessor - Interface in org.pfsw.bif.text

A simple interface that allows processing a longer text line by line.

ILongRepresentation - Interface in org.pfsw.bif.conversion

This interface defines the method an object must support, if it wants to represent itself as a long.

IMutableStringPair - Interface in org.pfsw.bif.text

Specifies additional methods for IStringPair objects that allow to modify them.

initialize() - Method in interface org.pfsw.bif.lifecycle.IInitializable

Initialize the internal state

IObjectCollector<T> - Interface in org.pfsw.bif

Implementors will be called by for elements in a loop or a recursive processing.

IObjectConverter<TSource,TTarget> - Interface in org.pfsw.bif.conversion

Defines a generic functional interface for the conversion of a given source object into a target object.

IObjectFilter<T> - Interface in org.pfsw.bif.filter

Defines just one method useful for generic filtering.

IObjectIdGenerator - Interface in org.pfsw.bif.identifier

Specifies the methods that are needed to generate new (unique) object identifiers.

IObjectProcessor<T> - Interface in org.pfsw.bif

Specifies a simple interface that allows loops or recursive executions to send each object to an implementor of this interface.

IORuntimeException - Exception in org.pfsw.bif.exceptions

A generic runtime exception that is supposed to be used for wrapping a checked IOException.

IORuntimeException(String, Object...) - Constructor for exception org.pfsw.bif.exceptions.IORuntimeException

 

IORuntimeException(IOException, String, Object...) - Constructor for exception org.pfsw.bif.exceptions.IORuntimeException

 

IORuntimeException(IOException) - Constructor for exception org.pfsw.bif.exceptions.IORuntimeException

 

IOutputStreamHandler - Interface in org.pfsw.bif.callback

A callback implementation that can be used to handle the output stream of any process that produces such a stream.

IParameterizedCondition<T> - Interface in org.pfsw.bif.logic

A condition that evaluates to true or false depending on an external parameter.

IPredicate<T> - Interface in org.pfsw.bif.callback

Can be used like Java 8 java.util.Predicate, but is available for Java 6.

IProgressListener - Interface in org.pfsw.bif.callback

A generic interface for listeners of any long-running actions that need to be observable and stoppable.

IReadOnlyNamedValues<TValue> - Interface in org.pfsw.bif.facet

Generic read only access to any name/value pair based containers where the names are strings and the values can be any type.

IReleasable - Interface in org.pfsw.bif.lifecycle

This interface specifies just a release() method an object must understand to release its internal resources.

IResettable - Interface in org.pfsw.bif.lifecycle

To be implemented by objects that can be reset.

IResumable - Interface in org.pfsw.bif.execution

Defines method resume().

isEmpty() - Method in interface org.pfsw.bif.facet.IReadOnlyNamedValues

Returns true if the receiver does not contain any data.

IService - Interface in org.pfsw.bif.execution

Generic tag interface to identify any kind of service

IServiceStateChangeListener - Interface in org.pfsw.bif.execution

A listener that gets informed about any state changes of a service.

ISO_8859_1 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_13 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_15 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_2 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_3 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_4 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_5 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_7 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_8 - Static variable in interface org.pfsw.bif.text.ICharsets

 

ISO_8859_9 - Static variable in interface org.pfsw.bif.text.ICharsets

 

IStartable - Interface in org.pfsw.bif.execution

To be implemented by classes that provide a service which can be started

IStoppable - Interface in org.pfsw.bif.execution

To be implemented by classes that provide a service which can be stopped

IStringConstant - Interface in org.pfsw.bif.text

Common interface of enumerations that define string constants.

IStringConverter<T> - Interface in org.pfsw.bif.conversion

Defines a generic functional interface for the conversion of a given source object into a String.

IStringFilter - Interface in org.pfsw.bif.text

A simple interface for abstraction of string matching.

IStringPair - Interface in org.pfsw.bif.text

Specifies a pair of String objects.

IStringRepresentation - Interface in org.pfsw.bif.text

This interface defines the method an object must support, if it wants to provide its string representation other than by the method toString().

isTrue() - Method in interface org.pfsw.bif.logic.ICondition

Returns whether or not the condition is true

isTrue(T) - Method in interface org.pfsw.bif.logic.IParameterizedCondition

Returns true if the condition evaluates to true for the given parameter.

ISupplier<T> - Interface in org.pfsw.bif.callback

Can be used like Java 8 java.util.Supplier, but is available for Java 6.

ISuspendable - Interface in org.pfsw.bif.execution

Defines method suspend()

ISystemExitListener - Interface in org.pfsw.bif.lifecycle

An implementor of this interface can be added to a listener list that

J

JSON_ARRAY_END - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_ARRAY_START - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_ELEMENT_SEPARATOR - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_LITERAL_FALSE - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_LITERAL_NULL - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_LITERAL_TRUE - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_OBJECT_END - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_OBJECT_START - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_PAIR_SEPARATOR - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_STRING_DELIMITER - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JSON_STRING_ESCAPE - Static variable in interface org.pfsw.bif.text.IJSONConvertible

 

JsonSyntaxElement - Enum in org.pfsw.bif.text

Defines an enumeration value for each JSON syntax element.

JVM_DEFAULT - Static variable in interface org.pfsw.bif.text.ICharsets

 

M

matches(T) - Method in interface org.pfsw.bif.filter.IObjectFilter

Returns true if the given object matches the filter.

matches(String) - Method in interface org.pfsw.bif.text.IStringFilter

Returns true if the given string matches the filter otherwise false.

N

name() - Method in interface org.pfsw.bif.enums.IEnumType

Returns the name of this enum constant, exactly as declared in its enum declaration.

newIdentifier() - Method in interface org.pfsw.bif.identifier.IObjectIdGenerator

Returns a new identifier which usually must be different to the previously returned.

newString(byte[]) - Method in interface org.pfsw.bif.text.ICheckedCharset

Returns a new String initialized with the given bytes which are expected to be encoded according to the character set this instance represents, avoiding the unnecessary exception handling (UnsupportedEncodingException).

NONE - Static variable in interface org.pfsw.bif.text.IStringFilter

A predefined filter that matches no string at all.

O

ordinal() - Method in interface org.pfsw.bif.enums.IEnumType

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

org.pfsw.bif - package org.pfsw.bif

 

org.pfsw.bif.callback - package org.pfsw.bif.callback

 

org.pfsw.bif.configuration - package org.pfsw.bif.configuration

 

org.pfsw.bif.conversion - package org.pfsw.bif.conversion

 

org.pfsw.bif.enums - package org.pfsw.bif.enums

 

org.pfsw.bif.exceptions - package org.pfsw.bif.exceptions

 

org.pfsw.bif.execution - package org.pfsw.bif.execution

Basic Interfaces for service classes
Defines some simple interfaces that specify typical methods in the area of service implementations.

org.pfsw.bif.facet - package org.pfsw.bif.facet

 

org.pfsw.bif.filter - package org.pfsw.bif.filter

Basic Interfaces for filter classes
Defines interfaces to be used with generic object filtering mechanisms.

org.pfsw.bif.identifier - package org.pfsw.bif.identifier

 

org.pfsw.bif.lifecycle - package org.pfsw.bif.lifecycle

Basic Interfaces for the object lifecycle
Defines some simple interfaces that specify typical methods in the area of an object's lifecycle.

org.pfsw.bif.logic - package org.pfsw.bif.logic

 

org.pfsw.bif.text - package org.pfsw.bif.text

 

P

processed(long, long) - Method in interface org.pfsw.bif.callback.IProgressListener

Will be called for each arbitrary chunk of work that has been processed.

processLine(String, int) - Method in interface org.pfsw.bif.text.ILineProcessor

Processes the given line and returns true if the caller should continue.

processObject(T) - Method in interface org.pfsw.bif.IObjectProcessor

Process the given object and return true if processing should be continued, otherwise false.

R

release() - Method in interface org.pfsw.bif.lifecycle.IReleasable

Release any resources that should not be referred to anymore in order to let the garbage collector take care of them.

reset() - Method in interface org.pfsw.bif.lifecycle.IResettable

Reset the internal state

resume() - Method in interface org.pfsw.bif.execution.IResumable

Resume the execution of the receiver's service

S

SERVICE_RESUMED - Static variable in interface org.pfsw.bif.execution.IServiceStateChangeListener

Indicates that the service has been resumed

SERVICE_STARTED - Static variable in interface org.pfsw.bif.execution.IServiceStateChangeListener

Indicates that the service has been started

SERVICE_STOPPED - Static variable in interface org.pfsw.bif.execution.IServiceStateChangeListener

Indicates that the service has been stopped

SERVICE_SUSPENDED - Static variable in interface org.pfsw.bif.execution.IServiceStateChangeListener

Indicates that the service has been suspended

serviceStateChanged(IService, int) - Method in interface org.pfsw.bif.execution.IServiceStateChangeListener

Will be called to signal a state change of the given service.

setString1(String) - Method in interface org.pfsw.bif.text.IMutableStringPair

Sets the first string to the given value.

setString2(String) - Method in interface org.pfsw.bif.text.IMutableStringPair

Sets the second string to the given value.

start() - Method in interface org.pfsw.bif.execution.IStartable

Start the service the implementing object provides

STOP - Static variable in interface org.pfsw.bif.callback.IProgressListener

The value returned by a listener that signals to stop processing.

stop() - Method in interface org.pfsw.bif.execution.IStoppable

Stop the service the implementing object provides

suspend() - Method in interface org.pfsw.bif.execution.ISuspendable

Suspends the execution of the receiver

systemAboutToExit(int) - Method in interface org.pfsw.bif.lifecycle.ISystemExitListener

This method should be called just before the program gets terminated by a System.exit(rc) call.

T

test(T) - Method in interface org.pfsw.bif.callback.IPredicate

Evaluates this predicate on the given argument.

toExternal(TInternal) - Method in interface org.pfsw.bif.conversion.IBidirectionalConverter

Converts the given internal object representation to its corresponding external representation.

toInternal(TExternal) - Method in interface org.pfsw.bif.conversion.IBidirectionalConverter

Converts the given external object representation to its corresponding internal representation.

toJSON() - Method in interface org.pfsw.bif.text.IJSONConvertible

The receiver of this method returns its internal state as JSON string representation.

toString() - Method in enum org.pfsw.bif.text.JsonSyntaxElement

 

U

UNDEFINED_SIZE - Static variable in interface org.pfsw.bif.callback.IProgressListener

This value specifies that the size is undefined or unknown.

US_ASCII - Static variable in interface org.pfsw.bif.text.ICharsets

 

UTF_16 - Static variable in interface org.pfsw.bif.text.ICharsets

 

UTF_16BE - Static variable in interface org.pfsw.bif.text.ICharsets

 

UTF_16LE - Static variable in interface org.pfsw.bif.text.ICharsets

 

UTF_8 - Static variable in interface org.pfsw.bif.text.ICharsets

 

V

valueOf(String) - Static method in enum org.pfsw.bif.logic.BooleanOperation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pfsw.bif.text.JsonSyntaxElement

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.pfsw.bif.logic.BooleanOperation

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.pfsw.bif.text.JsonSyntaxElement

Returns an array containing the constants of this enum type, in the order they are declared.