Package io.protostuff

Class SmileIOUtil

  • public final class SmileIOUtil
extends java.lang.Object
    Smile IO utilities for messages.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SmileIOUtil.Factory
      A custom factory simply to expose certain fields.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SmileIOUtil()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static <T> void mergeFrom​(byte[] data, int offset, int length, T message, Schema<T> schema, boolean numeric)
      Merges the message with the byte array using the given schema.
      static <T> void mergeFrom​(byte[] data, T message, Schema<T> schema, boolean numeric)
      Merges the message with the byte array using the given schema.
      static <T> void mergeFrom​(java.io.InputStream in, T message, Schema<T> schema, boolean numeric)
      Merges the message from the InputStream using the given schema.
      static <T> void mergeFrom​(java.io.InputStream in, T message, Schema<T> schema, boolean numeric, LinkedBuffer buffer)
      Merges the message from the InputStream using the given schema.
      static Pipe newPipe​(byte[] data, boolean numeric)
      Creates a smile pipe from a byte array.
      static Pipe newPipe​(byte[] data, int offset, int length, boolean numeric)
      Creates a smile pipe from a byte array.
      static Pipe newPipe​(java.io.InputStream in, boolean numeric)
      Creates a smile pipe from an InputStream.
      static com.fasterxml.jackson.dataformat.smile.SmileGenerator newSmileGenerator​(java.io.OutputStream out, byte[] buf)
      Creates a SmileGenerator for the outputstream with the supplied buf outBuffer to use.
      (package private) static com.fasterxml.jackson.dataformat.smile.SmileGenerator newSmileGenerator​(java.io.OutputStream out, byte[] buf, int offset, boolean bufferRecyclable, com.fasterxml.jackson.core.io.IOContext context)
      Creates a SmileGenerator for the outputstream with the supplied buf outBuffer to use.
      static com.fasterxml.jackson.dataformat.smile.SmileParser newSmileParser​(java.io.InputStream in, byte[] buf, int offset, int limit)
      Creates a SmileParser from the inputstream with the supplied buf inBuffer to use.
      (package private) static com.fasterxml.jackson.dataformat.smile.SmileParser newSmileParser​(java.io.InputStream in, byte[] buf, int offset, int limit, boolean bufferRecyclable, com.fasterxml.jackson.core.io.IOContext context)
      Creates a SmileParser from the inputstream with the supplied buf inBuffer to use.
      static <T> java.util.List<T> parseListFrom​(java.io.InputStream in, Schema<T> schema, boolean numeric)
      Parses the messages from the stream using the given schema.
      static <T> java.util.List<T> parseListFrom​(java.io.InputStream in, Schema<T> schema, boolean numeric, LinkedBuffer buffer)
      Parses the messages from the stream using the given schema.
      static <T> byte[] toByteArray​(T message, Schema<T> schema, boolean numeric)
      Serializes the message into a byte array using the given schema.
      static <T> byte[] toByteArray​(T message, Schema<T> schema, boolean numeric, LinkedBuffer buffer)
      Serializes the message into a byte array using the given schema.
      static <T> void writeListTo​(java.io.OutputStream out, java.util.List<T> messages, Schema<T> schema, boolean numeric)
      Serializes the messages into the stream using the given schema.
      static <T> void writeListTo​(java.io.OutputStream out, java.util.List<T> messages, Schema<T> schema, boolean numeric, LinkedBuffer buffer)
      Serializes the messages into the stream using the given schema.
      static <T> void writeTo​(java.io.OutputStream out, T message, Schema<T> schema, boolean numeric)
      Serializes the message into an OutputStream using the given schema.
      static <T> void writeTo​(java.io.OutputStream out, T message, Schema<T> schema, boolean numeric, LinkedBuffer buffer)
      Serializes the message into an OutputStream using the given schema.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_SMILE_FACTORY

        public static final SmileIOUtil.Factory DEFAULT_SMILE_FACTORY
        The default smile factory for creating smile parsers and generators.

    • Constructor Detail

      • SmileIOUtil

        private SmileIOUtil()

    • Method Detail

      • newPipe

        public static Pipe newPipe​(byte[] data,
                           boolean numeric)
                    throws java.io.IOException
        Creates a smile pipe from a byte array.
        Throws:
        java.io.IOException

      • newPipe

        public static Pipe newPipe​(byte[] data,
                           int offset,
                           int length,
                           boolean numeric)
                    throws java.io.IOException
        Creates a smile pipe from a byte array.
        Throws:
        java.io.IOException

      • newPipe

        public static Pipe newPipe​(java.io.InputStream in,
                           boolean numeric)
                    throws java.io.IOException
        Creates a smile pipe from an InputStream.
        Throws:
        java.io.IOException

      • newSmileParser

        public static com.fasterxml.jackson.dataformat.smile.SmileParser newSmileParser​(java.io.InputStream in,
                                                                                byte[] buf,
                                                                                int offset,
                                                                                int limit)
                                                                         throws java.io.IOException
        Creates a SmileParser from the inputstream with the supplied buf inBuffer to use.
        Throws:
        java.io.IOException

      • newSmileParser

        static com.fasterxml.jackson.dataformat.smile.SmileParser newSmileParser​(java.io.InputStream in,
                                                                         byte[] buf,
                                                                         int offset,
                                                                         int limit,
                                                                         boolean bufferRecyclable,
                                                                         com.fasterxml.jackson.core.io.IOContext context)
                                                                  throws java.io.IOException
        Creates a SmileParser from the inputstream with the supplied buf inBuffer to use.
        Throws:
        java.io.IOException

      • newSmileGenerator

        public static com.fasterxml.jackson.dataformat.smile.SmileGenerator newSmileGenerator​(java.io.OutputStream out,
                                                                                      byte[] buf)
        Creates a SmileGenerator for the outputstream with the supplied buf outBuffer to use.

      • newSmileGenerator

        static com.fasterxml.jackson.dataformat.smile.SmileGenerator newSmileGenerator​(java.io.OutputStream out,
                                                                               byte[] buf,
                                                                               int offset,
                                                                               boolean bufferRecyclable,
                                                                               com.fasterxml.jackson.core.io.IOContext context)
        Creates a SmileGenerator for the outputstream with the supplied buf outBuffer to use.

      • mergeFrom

        public static <T> void mergeFrom​(byte[] data,
                                 T message,
                                 Schema<T> schema,
                                 boolean numeric)
                          throws java.io.IOException
        Merges the message with the byte array using the given schema.
        Throws:
        java.io.IOException

      • mergeFrom

        public static <T> void mergeFrom​(byte[] data,
                                 int offset,
                                 int length,
                                 T message,
                                 Schema<T> schema,
                                 boolean numeric)
                          throws java.io.IOException
        Merges the message with the byte array using the given schema.
        Throws:
        java.io.IOException

      • mergeFrom

        public static <T> void mergeFrom​(java.io.InputStream in,
                                 T message,
                                 Schema<T> schema,
                                 boolean numeric)
                          throws java.io.IOException
        Merges the message from the InputStream using the given schema.
        Throws:
        java.io.IOException

      • mergeFrom

        public static <T> void mergeFrom​(java.io.InputStream in,
                                 T message,
                                 Schema<T> schema,
                                 boolean numeric,
                                 LinkedBuffer buffer)
                          throws java.io.IOException
        Merges the message from the InputStream using the given schema.

        The LinkedBuffer's internal byte array will be used when reading the message.

        Throws:
        java.io.IOException

      • toByteArray

        public static <T> byte[] toByteArray​(T message,
                                     Schema<T> schema,
                                     boolean numeric)
        Serializes the message into a byte array using the given schema.

      • toByteArray

        public static <T> byte[] toByteArray​(T message,
                                     Schema<T> schema,
                                     boolean numeric,
                                     LinkedBuffer buffer)
        Serializes the message into a byte array using the given schema.

        The LinkedBuffer's internal byte array will be used as the primary buffer when writing the message.

      • writeTo

        public static <T> void writeTo​(java.io.OutputStream out,
                               T message,
                               Schema<T> schema,
                               boolean numeric)
                        throws java.io.IOException
        Serializes the message into an OutputStream using the given schema.
        Throws:
        java.io.IOException

      • writeTo

        public static <T> void writeTo​(java.io.OutputStream out,
                               T message,
                               Schema<T> schema,
                               boolean numeric,
                               LinkedBuffer buffer)
                        throws java.io.IOException
        Serializes the message into an OutputStream using the given schema.

        The LinkedBuffer's internal byte array will be used as the primary buffer when writing the message.

        Throws:
        java.io.IOException

      • writeListTo

        public static <T> void writeListTo​(java.io.OutputStream out,
                                   java.util.List<T> messages,
                                   Schema<T> schema,
                                   boolean numeric)
                            throws java.io.IOException
        Serializes the messages into the stream using the given schema.
        Throws:
        java.io.IOException

      • writeListTo

        public static <T> void writeListTo​(java.io.OutputStream out,
                                   java.util.List<T> messages,
                                   Schema<T> schema,
                                   boolean numeric,
                                   LinkedBuffer buffer)
                            throws java.io.IOException
        Serializes the messages into the stream using the given schema.

        The LinkedBuffer's internal byte array will be used as the primary buffer when writing the message.

        Throws:
        java.io.IOException

      • parseListFrom

        public static <T> java.util.List<T> parseListFrom​(java.io.InputStream in,
                                                  Schema<T> schema,
                                                  boolean numeric)
                                           throws java.io.IOException
        Parses the messages from the stream using the given schema.
        Throws:
        java.io.IOException

      • parseListFrom

        public static <T> java.util.List<T> parseListFrom​(java.io.InputStream in,
                                                  Schema<T> schema,
                                                  boolean numeric,
                                                  LinkedBuffer buffer)
                                           throws java.io.IOException
        Parses the messages from the stream using the given schema.

        The LinkedBuffer's internal byte array will be used when reading the message.

        Throws:
        java.io.IOException