org.xwiki.model.internal.reference
Class AbstractReferenceEntityReferenceResolver

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

All Implemented Interfaces:

EntityReferenceResolver<EntityReference>

Direct Known Subclasses:

DefaultReferenceEntityReferenceResolver, ExplicitReferenceEntityReferenceResolver

public abstract class AbstractReferenceEntityReferenceResolver
extends java.lang.Object
implements EntityReferenceResolver<EntityReference>

Resolve an EntityReference into a valid and absolute reference (with all required parents filled in).

Since:

2.2.3

Version:

$Id$

Constructor Summary

AbstractReferenceEntityReferenceResolver()

Method Summary

protected abstract java.lang.String	getDefaultValue(EntityType type, java.lang.Object... parameters)
EntityReference	resolve(EntityReference referenceToResolve, 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

AbstractReferenceEntityReferenceResolver

public AbstractReferenceEntityReferenceResolver()

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(EntityReference referenceToResolve,
                               EntityType type,
                               java.lang.Object... parameters)

Specified by:

resolve in interface EntityReferenceResolver<EntityReference>

Parameters:

referenceToResolve - 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...)