org.xwiki.model.internal.reference
Class DefaultStringDocumentReferenceResolver

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

All Implemented Interfaces:

DocumentReferenceResolver<java.lang.String>

@Component
@Singleton
public class DefaultStringDocumentReferenceResolver
extends java.lang.Object
implements DocumentReferenceResolver<java.lang.String>

Specialized version of EntityReferenceResolver which can be considered a helper component to resolve DocumentReference objects from their string representation. This implementation uses fixed default values when parts of the Reference are missing in the string representation. Default values are retrieved from the ModelConfiguration class.

Since:

2.2M1

Version:

$Id$

Constructor Summary

DefaultStringDocumentReferenceResolver()

Method Summary

DocumentReference

resolve(java.lang.String documentReferenceRepresentation, java.lang.Object... parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultStringDocumentReferenceResolver

public DefaultStringDocumentReferenceResolver()

Method Detail

resolve

public DocumentReference resolve(java.lang.String documentReferenceRepresentation,
                                 java.lang.Object... parameters)

Specified by:

resolve in interface DocumentReferenceResolver<java.lang.String>

Parameters:

documentReferenceRepresentation - the representation of a document reference (eg as a String)

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

Returns:

the valid resolved document reference as an Object

See Also:

DocumentReferenceResolver.resolve(T, java.lang.Object...)