Package org.craftercms.studio.api.v1.content.pipeline

Interface PipelineContent

All Known Implementing Classes:
PipelineContentImpl
public interface PipelineContent
wrapper to content that is being processed through the content processor pipeline
Author:
hyanghee

  • Field Details

  • Method Details

    • getId

      String getId()
      get the id of this content
      Returns:
      id

    • setId

      void setId(String id)
      set the id of this content
      Parameters:
      id -

    • getContentStream

      InputStream getContentStream() throws ContentProcessException
      get this content as input stream
      Returns:
      input stream
      Throws:
      ContentProcessException

    • setContentStream

      void setContentStream(InputStream contentStream)
      set content input stream.this will reset document.
      Parameters:
      contentStream -

    • getDocument

      org.dom4j.Document getDocument() throws ContentProcessException
      get this content as XML Document
      Returns:
      document
      Throws:
      ContentProcessException

    • setDocument

      void setDocument(org.dom4j.Document document)
      set the content document. this will reset content stream
      Parameters:
      document -

    • getEncoding

      String getEncoding()
      get the encoding of this content
      Returns:
      encoding

    • setEncoding

      void setEncoding(String encoding)
      set the encoding of this content
      Parameters:
      encoding -

    • getProperties

      Map<String,String> getProperties()
      get properties of this content
      Returns:
      properties

    • setProperties

      void setProperties(Map<String,String> properties)
      set content properties
      Parameters:
      properties -

    • addProperty

      void addProperty(String key, String value)
      add a content property
      Parameters:
      key -
      value -

    • getProperty

      String getProperty(String key)
      get a property value given the key
      Parameters:
      key -
      Returns:
      property value

    • closeContentStream

      void closeContentStream()
      close this content