de.smartics.properties.admin.resources.representation.xml.share
Class AbstractXmlRepresentationRenderer<T>

java.lang.Object
  de.smartics.properties.admin.resources.representation.share.AbstractRepresentationRenderer<T>
      de.smartics.properties.admin.resources.representation.xml.share.AbstractXmlRepresentationRenderer<T>

Type Parameters:

T - the type of the resource the renderer is rendering representations for.

All Implemented Interfaces:

de.smartics.resteasy.hypermedia.renderer.RepresentationRenderer<T>

Direct Known Subclasses:

ApiServicesXmlRepresentationRenderer, ConfigurationKeysXmlRepresentationRenderer, PropertyDescriptorsXmlRepresentationRenderer, PropertyDescriptorXmlRepresentationRenderer, PropertyKeysXmlRepresentationRenderer, PropertyXmlRepresentationRenderer

public abstract class AbstractXmlRepresentationRenderer<T>
     
     

      
      extends 
      
      AbstractRepresentationRenderer<T>
     
     

Base implementation for XML documents.

Field Summary

protected de.smartics.resteasy.hypermedia.renderer.ResourceContext	context The context information to render the representation.
protected de.smartics.properties.utils.HtmlUtils	htmlUtils Utilities to deal with HTML.

Fields inherited from class de.smartics.properties.admin.resources.representation.share.AbstractRepresentationRenderer

breadcrumb, characterEncoding, entityStream, linkDescriptorFactory, pathHelper

Constructor Summary

protected

AbstractXmlRepresentationRenderer(de.smartics.resteasy.hypermedia.renderer.ResourceContext context, OutputStream entityStream) Default constructor using a stream.

Method Summary

protected abstract List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	hyperLinks() Returns the hyperlinks to attach to the HTTP headers.
protected void	renderAdditionalHttpHeader(javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders) Hook to override in subclasses to add additional HTTP headers.

Methods inherited from class de.smartics.properties.admin.resources.representation.share.AbstractRepresentationRenderer

close, httpBody, render, renderHttpHeaderLink

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final de.smartics.resteasy.hypermedia.renderer.ResourceContext context

The context information to render the representation.

htmlUtils

protected final de.smartics.properties.utils.HtmlUtils htmlUtils

Utilities to deal with HTML.

Constructor Detail

AbstractXmlRepresentationRenderer

protected AbstractXmlRepresentationRenderer(de.smartics.resteasy.hypermedia.renderer.ResourceContext context,
                                            OutputStream entityStream)

Default constructor using a stream.

Parameters:

context - the context information to render the representation.

entityStream - the stream to write to.

Method Detail

hyperLinks

protected abstract List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> hyperLinks()

Returns the hyperlinks to attach to the HTTP headers.

Returns:

the hyperlinks to attach to the HTTP headers.

renderAdditionalHttpHeader

protected void renderAdditionalHttpHeader(javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders)

Description copied from class: AbstractRepresentationRenderer

Hook to override in subclasses to add additional HTTP headers.

Overrides:

renderAdditionalHttpHeader in class AbstractRepresentationRenderer<T>

Parameters:

httpHeaders - the headers to add to.