org.fcrepo.kernel.identifiers

Class IdentifierConverter<A,B>

java.lang.Object

com.google.common.base.Converter<A,B>

org.fcrepo.kernel.identifiers.IdentifierConverter<A,B>

Type Parameters:

B - the type to and from which we are translating

All Implemented Interfaces:

com.google.common.base.Function<A,B>

Direct Known Subclasses:

DefaultIdentifierTranslator, HttpResourceConverter

public abstract class IdentifierConverter<A,B>
extends com.google.common.base.Converter<A,B>

An IdentifierConverter accepts and returns identifiers, translating them in some type-specific manner. The typical use of this contract is for translating between internal and external identifiers.

Since:

Mar 26, 2014

Author:

ajs6f

Constructor Summary

Constructors

Constructor and Description
IdentifierConverter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	asString(A resource) Convert the given resource into a plain string representation of the conversion to the resource
boolean	inDomain(A resource) Check if the given resource is in the domain of this converter
abstract A	toDomain(String resource) Convert a plain string to a resource appropriate to this converter

Methods inherited from class com.google.common.base.Converter

andThen, apply, convert, convertAll, doBackward, doForward, equals, from, identity, reverse

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentifierConverter

public IdentifierConverter()

Method Detail

inDomain

public boolean inDomain(A resource)

Check if the given resource is in the domain of this converter

Parameters:

resource - the given resource

Returns:

boolean value of the check

toDomain

public abstract A toDomain(String resource)

Convert a plain string to a resource appropriate to this converter

Parameters:

resource - the plain string resource

Returns:

the resource appropriate to this converter

asString

public abstract String asString(A resource)

Convert the given resource into a plain string representation of the conversion to the resource

Parameters:

resource - the given resource

Returns:

a plain string representation of the conversion to the resource