org.xwiki.model.internal.reference
Class AbstractStringEntityReferenceResolver

java.lang.Object
  org.xwiki.model.internal.reference.AbstractStringEntityReferenceResolver

All Implemented Interfaces:

EntityReferenceResolver<java.lang.String>

Direct Known Subclasses:

DefaultStringEntityReferenceResolver, ExplicitStringEntityReferenceResolver, RelativeStringEntityReferenceResolver

public abstract class AbstractStringEntityReferenceResolver
extends java.lang.Object
implements EntityReferenceResolver<java.lang.String>

Generic implementation deferring default values for unspecified reference parts to extending classes. This allows for example both the Current Entity Reference Resolver and the Default Entity Reference Resolver to share the code from this class.

Since:

2.2M1

Version:

$Id$

Constructor Summary

AbstractStringEntityReferenceResolver()

Method Summary

protected abstract java.lang.String	getDefaultValue(EntityType type, java.lang.Object... parameters)
EntityReference	resolve(java.lang.String entityReferenceRepresentation, EntityType type, java.lang.Object... parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStringEntityReferenceResolver

public AbstractStringEntityReferenceResolver()

Method Detail

getDefaultValue

protected abstract java.lang.String getDefaultValue(EntityType type,
                                                    java.lang.Object... parameters)

Parameters:

type - the entity type for which to return the default value to use (since the use has not specified it)

parameters - optional parameters. Their meaning depends on the resolver implementation

Returns:

the default value to use

resolve

public EntityReference resolve(java.lang.String entityReferenceRepresentation,
                               EntityType type,
                               java.lang.Object... parameters)

Specified by:

resolve in interface EntityReferenceResolver<java.lang.String>

Parameters:

entityReferenceRepresentation - the representation of an entity reference (eg as a String)

type - the type of the Entity (Document, Space, Attachment, Wiki, etc) to resolve out of the representation

parameters - optional parameters. Their meaning depends on the resolver implementation

Returns:

the valid resolved reference as an Object

See Also:

EntityReferenceResolver.resolve(T, org.xwiki.model.EntityType, java.lang.Object...)