Package org.nuxeo.ecm.platform.url.service

Class AbstractDocumentViewCodec

java.lang.Object

org.nuxeo.ecm.platform.url.service.AbstractDocumentViewCodec

All Implemented Interfaces:

DocumentViewCodec

Direct Known Subclasses:

DocumentFileCodec, DocumentIdCodec, DocumentPathCodec, DocumentPreviewCodec, RestDocumentViewCodec, WebUIRedirectCodec

public abstract class AbstractDocumentViewCodec
extends Object
implements DocumentViewCodec

Abstract implementation for codecs.

Implements methods that are not likely to be customized except for optimization.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field	Description
protected String	prefix

Constructor Summary

Constructors

Constructor	Description
AbstractDocumentViewCodec()

Method Summary

Modifier and Type	Method	Description
String	getPrefix()
boolean	handleDocumentView(DocumentView docView)	Returns true if this codec should apply when iterating over codecs to find a matching one.
boolean	handleUrl(String url)	Returns true if this codec should apply when iterating over codecs to find a matching one.
void	setPrefix(String prefix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.url.codec.api.DocumentViewCodec

getDocumentViewFromUrl, getUrlFromDocumentView

Field Details

prefix

protected String prefix

Constructor Details

AbstractDocumentViewCodec

public AbstractDocumentViewCodec()

Method Details

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface DocumentViewCodec

setPrefix

public void setPrefix(String prefix)

Specified by:

setPrefix in interface DocumentViewCodec

handleDocumentView

public boolean handleDocumentView(DocumentView docView)

Description copied from interface: DocumentViewCodec

Returns true if this codec should apply when iterating over codecs to find a matching one.

Specified by:

handleDocumentView in interface DocumentViewCodec

See Also:

• DocumentViewCodecManager.getUrlFromDocumentView(DocumentView, boolean, String)

handleUrl

public boolean handleUrl(String url)

Description copied from interface: DocumentViewCodec

Returns true if this codec should apply when iterating over codecs to find a matching one.

Specified by:

handleUrl in interface DocumentViewCodec

See Also:

• DocumentViewCodecManager.getDocumentViewFromUrl(String, boolean, String)