org.xwiki.model.internal.reference
Class DefaultStringEntityReferenceSerializer

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

All Implemented Interfaces:

EntityReferenceSerializer<java.lang.String>

Direct Known Subclasses:

LocalStringEntityReferenceSerializer

@Component
public class DefaultStringEntityReferenceSerializer
extends java.lang.Object
implements EntityReferenceSerializer<java.lang.String>

Generate a string representation of an entity reference (eg "wiki:space.page" for a document reference in the "wiki" Wiki, the "space" Space and the "page" Page).

Since:

2.2M1

Version:

$Id$

Constructor Summary

DefaultStringEntityReferenceSerializer()

Method Summary

java.lang.String	serialize(EntityReference reference, java.lang.Object... parameters)
protected void	serializeEntityReference(EntityReference currentReference, java.lang.StringBuilder representation, boolean isLastReference, java.lang.Object... parameters) Serialize a reference element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultStringEntityReferenceSerializer

public DefaultStringEntityReferenceSerializer()

Method Detail

serialize

public java.lang.String serialize(EntityReference reference,
                                  java.lang.Object... parameters)

Specified by:

serialize in interface EntityReferenceSerializer<java.lang.String>

Parameters:

reference - the reference to serialize

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

Returns:

the new representation (eg as a String)

See Also:

EntityReferenceSerializer.serialize(org.xwiki.model.reference.EntityReference, Object...)

serializeEntityReference

protected void serializeEntityReference(EntityReference currentReference,
                                        java.lang.StringBuilder representation,
                                        boolean isLastReference,
                                        java.lang.Object... parameters)

Serialize a reference element.

Parameters:

currentReference - the reference to serialize

representation - the builder where to happen the serialized member

isLastReference - indicate if it's the last member of the refence

parameters - optional parameters