Interface JSONArtifact

  • All Known Implementing Classes:
    JSONArray, JSONObject, OrderedJSONObject

    public interface JSONArtifact
    Interface class to define a set of generic apis both JSONObject and JSON array implement. This is namely so that functions such as serialize, which are common between the two, can be easily invoked.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String serialize()
      Convert this object into a String of JSON text.
      java.lang.String serialize​(boolean verbose)
      Convert this object into a String of JSON text, specifying verbosity.
      void serialize​(java.io.OutputStream os)
      Convert this object into a stream of JSON text.
      void serialize​(java.io.OutputStream os, boolean verbose)
      Convert this object into a stream of JSON text.
      void serialize​(java.io.Writer writer)
      Convert this object into a stream of JSON text.
      void serialize​(java.io.Writer writer, boolean verbose)
      Convert this object into a stream of JSON text, specifying verbosity.
    • Method Detail

      • serialize

        void serialize​(java.io.OutputStream os)
                throws java.io.IOException
        Convert this object into a stream of JSON text. Same as calling serialize(os,false); Note that encoding is always written as UTF-8, as per JSON spec.
        Parameters:
        os - The output stream to serialize data to.
        Throws:
        java.io.IOException - Thrown on IO errors during serialization.
      • serialize

        void serialize​(java.io.OutputStream os,
                       boolean verbose)
                throws java.io.IOException
        Convert this object into a stream of JSON text. Same as calling serialize(writer,false); Note that encoding is always written as UTF-8, as per JSON spec.
        Parameters:
        os - The output stream to serialize data to.
        verbose - Whether or not to write the JSON text in a verbose format.
        Throws:
        java.io.IOException - Thrown on IO errors during serialization.
      • serialize

        void serialize​(java.io.Writer writer)
                throws java.io.IOException
        Convert this object into a stream of JSON text. Same as calling serialize(writer,false);
        Parameters:
        writer - The writer which to serialize the JSON text to.
        Throws:
        java.io.IOException - Thrown on IO errors during serialization.
      • serialize

        void serialize​(java.io.Writer writer,
                       boolean verbose)
                throws java.io.IOException
        Convert this object into a stream of JSON text, specifying verbosity.
        Parameters:
        writer - The writer which to serialize the JSON text to.
        Throws:
        java.io.IOException - Thrown on IO errors during serialization.
      • serialize

        java.lang.String serialize​(boolean verbose)
                            throws java.io.IOException
        Convert this object into a String of JSON text, specifying verbosity.
        Parameters:
        verbose - Whether or not to serialize in compressed for formatted Strings.
        Throws:
        java.io.IOException - Thrown on IO errors during serialization.
      • serialize

        java.lang.String serialize()
                            throws java.io.IOException
        Convert this object into a String of JSON text. Same as serialize(false);
        Throws:
        java.io.IOException - Thrown on IO errors during serialization.