Package org.eclipse.text.templates

Class TemplateReaderWriter

java.lang.Object
org.eclipse.text.templates.TemplateReaderWriter
Direct Known Subclasses:
TemplateReaderWriter
public class TemplateReaderWriter extends Object
Serializes templates as character or byte stream and reads the same format back.

Clients may instantiate this class, it is not intended to be subclassed.

Since:
3.7
Restriction:
This class is not intended to be subclassed by clients.

  • Constructor Details

    • TemplateReaderWriter

      public TemplateReaderWriter()
      Create a new instance.

  • Method Details

    • read

      public TemplatePersistenceData[] read(Reader reader) throws IOException
      Reads templates from a reader and returns them. The reader must present a serialized form as produced by the save method.
      Parameters:
      reader - the reader to read templates from
      Returns:
      the read templates, encapsulated in instances of TemplatePersistenceData
      Throws:
      IOException - if reading from the stream fails

    • readSingle

      public TemplatePersistenceData readSingle(Reader reader, String id) throws IOException
      Reads the template with identifier id from a reader and returns it. The reader must present a serialized form as produced by the save method.
      Parameters:
      reader - the reader to read templates from
      id - the id of the template to return
      Returns:
      the read template, encapsulated in an instances of TemplatePersistenceData
      Throws:
      IOException - if reading from the stream fails
      Since:
      3.1

    • read

      public TemplatePersistenceData[] read(Reader reader, ResourceBundle bundle) throws IOException
      Reads templates from a stream and adds them to the templates.
      Parameters:
      reader - the reader to read templates from
      bundle - a resource bundle to use for translating the read templates, or null if no translation should occur
      Returns:
      the read templates, encapsulated in instances of TemplatePersistenceData
      Throws:
      IOException - if reading from the stream fails

    • read

      public TemplatePersistenceData[] read(InputStream stream, ResourceBundle bundle) throws IOException
      Reads templates from a stream and adds them to the templates.
      Parameters:
      stream - the byte stream to read templates from
      bundle - a resource bundle to use for translating the read templates, or null if no translation should occur
      Returns:
      the read templates, encapsulated in instances of TemplatePersistenceData
      Throws:
      IOException - if reading from the stream fails

    • save

      public void save(TemplatePersistenceData[] templates, OutputStream stream) throws IOException
      Saves the templates as XML, encoded as UTF-8 onto the given byte stream.
      Parameters:
      templates - the templates to save
      stream - the byte output to write the templates to in XML
      Throws:
      IOException - if writing the templates fails

    • save

      public void save(TemplatePersistenceData[] templates, Writer writer) throws IOException
      Saves the templates as XML.
      Parameters:
      templates - the templates to save
      writer - the writer to write the templates to in XML
      Throws:
      IOException - if writing the templates fails