Jackson-core 2.16.0 · com.fasterxml.jackson.core.SerializableString

Method Summary

Modifier and Type	Method and Description
public int	Returns: Number of characters appended, if successful, otherwise -1 appendQuoted(char[] Buffer to append JSON-escaped String into buffer, int Offset in `buffer` to append String at offset) Method that will append quoted characters of this String into given buffer.
public int	Returns: Number of bytes appended, if successful, otherwise -1 appendQuotedUTF8(byte[] Buffer to append JSON-escaped String into buffer, int Offset in `buffer` to append String at offset) Method that will append quoted UTF-8 bytes of this String into given buffer, if there is enough room; if not, returns -1.
public int	Returns: Number of characters appended, if successful, otherwise -1 appendUnquoted(char[] Buffer to append literal (unescaped) String into buffer, int Offset in `buffer` to append String at offset) Method that will append unquoted characters of this String into given buffer.
public int	Returns: Number of bytes appended, if successful, otherwise -1 appendUnquotedUTF8(byte[] Buffer to append literal (unescaped) String into buffer, int Offset in `buffer` to append String at offset) Method that will append unquoted ('raw') UTF-8 bytes of this String into given buffer.
public char[]	Returns: JSON quoted form of the String as `char[]` asQuotedChars() Returns JSON quoted form of the String, as character array.
public byte[]	Returns: UTF-8 encoded version of JSON-escaped String asQuotedUTF8() Returns UTF-8 encoded version of JSON-quoted String.
public byte[]	Returns: UTF-8 encoded version of String, without any escaping asUnquotedUTF8() Returns UTF-8 encoded version of unquoted String.
public int	Returns: Length of the String in characters charLength() Returns length of the (unquoted) String as characters.
public String	Returns: Unquoted String getValue() Returns unquoted String that this object represents (and offers serialized forms for)
public int	Returns: Number of bytes put, if contents fit, otherwise -1 putQuotedUTF8(ByteBuffer `java.nio.ByteBuffer` to append String into buffer) Method for appending JSON-escaped UTF-8 encoded String value into given `java.nio.ByteBuffer`, if it fits.
public int	Returns: Number of bytes put, if contents fit, otherwise -1 putUnquotedUTF8(ByteBuffer `java.nio.ByteBuffer` to append String into buffer) Method for appending unquoted ('raw') UTF-8 encoded String value into given `java.nio.ByteBuffer`, if it fits.
public int	Returns: Number of bytes written writeQuotedUTF8(OutputStream `java.io.OutputStream` to write String into out) Method for writing JSON-escaped UTF-8 encoded String value using given `java.io.OutputStream`.
public int	Returns: Number of bytes written writeUnquotedUTF8(OutputStream `java.io.OutputStream` to write String into out) Method for writing unescaped UTF-8 encoded String value using given `java.io.OutputStream`.

Method Detail

appendQuoted back to summary

appendQuoted	back to summary
public int appendQuoted(char[] buffer, int offset) Method that will append quoted characters of this String into given buffer. Functionally equivalent to: char[] ch = str.asQuotedChars(); System.arraycopy(ch, 0, buffer, offset, ch.length); return ch.length; Parameters buffer:char[] Buffer to append JSON-escaped String into offset:int Offset in `buffer` to append String at Returns:int Number of characters appended, if successful, otherwise -1

public int appendQuoted(char[] buffer, int offset)

Method that will append quoted characters of this String into given buffer. Functionally equivalent to:

  char[] ch = str.asQuotedChars();
  System.arraycopy(ch, 0, buffer, offset, ch.length);
  return ch.length;

Parameters

buffer:char[]: Buffer to append JSON-escaped String into
offset:int: Offset in buffer to append String at

Returns:int

Number of characters appended, if successful, otherwise -1

appendQuotedUTF8 back to summary

appendQuotedUTF8	back to summary
public int appendQuotedUTF8(byte[] buffer, int offset) Method that will append quoted UTF-8 bytes of this String into given buffer, if there is enough room; if not, returns -1. Functionally equivalent to: byte[] bytes = str.asQuotedUTF8(); System.arraycopy(bytes, 0, buffer, offset, bytes.length); return bytes.length; Parameters buffer:byte[] Buffer to append JSON-escaped String into offset:int Offset in `buffer` to append String at Returns:int Number of bytes appended, if successful, otherwise -1

public int appendQuotedUTF8(byte[] buffer, int offset)

Method that will append quoted UTF-8 bytes of this String into given buffer, if there is enough room; if not, returns -1. Functionally equivalent to:

  byte[] bytes = str.asQuotedUTF8();
  System.arraycopy(bytes, 0, buffer, offset, bytes.length);
  return bytes.length;

Parameters

buffer:byte[]: Buffer to append JSON-escaped String into
offset:int: Offset in buffer to append String at

Returns:int

Number of bytes appended, if successful, otherwise -1

appendUnquoted back to summary

appendUnquoted	back to summary
public int appendUnquoted(char[] buffer, int offset) Method that will append unquoted characters of this String into given buffer. Functionally equivalent to: char[] ch = str.getValue().toCharArray(); System.arraycopy(bytes, 0, buffer, offset, ch.length); return ch.length; Parameters buffer:char[] Buffer to append literal (unescaped) String into offset:int Offset in `buffer` to append String at Returns:int Number of characters appended, if successful, otherwise -1

public int appendUnquoted(char[] buffer, int offset)

Method that will append unquoted characters of this String into given buffer. Functionally equivalent to:

  char[] ch = str.getValue().toCharArray();
  System.arraycopy(bytes, 0, buffer, offset, ch.length);
  return ch.length;

Parameters

buffer:char[]: Buffer to append literal (unescaped) String into
offset:int: Offset in buffer to append String at

Returns:int

Number of characters appended, if successful, otherwise -1

appendUnquotedUTF8 back to summary

appendUnquotedUTF8	back to summary
public int appendUnquotedUTF8(byte[] buffer, int offset) Method that will append unquoted ('raw') UTF-8 bytes of this String into given buffer. Functionally equivalent to: byte[] bytes = str.asUnquotedUTF8(); System.arraycopy(bytes, 0, buffer, offset, bytes.length); return bytes.length; Parameters buffer:byte[] Buffer to append literal (unescaped) String into offset:int Offset in `buffer` to append String at Returns:int Number of bytes appended, if successful, otherwise -1

public int appendUnquotedUTF8(byte[] buffer, int offset)

Method that will append unquoted ('raw') UTF-8 bytes of this String into given buffer. Functionally equivalent to:

  byte[] bytes = str.asUnquotedUTF8();
  System.arraycopy(bytes, 0, buffer, offset, bytes.length);
  return bytes.length;

Parameters

buffer:byte[]: Buffer to append literal (unescaped) String into
offset:int: Offset in buffer to append String at

Returns:int

Number of bytes appended, if successful, otherwise -1

asQuotedChars back to summary

asQuotedChars	back to summary
public char[] asQuotedChars() Returns JSON quoted form of the String, as character array. Result can be embedded as-is in textual JSON as property name or JSON String. Returns:char[] JSON quoted form of the String as `char[]`

public char[] asQuotedChars()

Returns JSON quoted form of the String, as character array. Result can be embedded as-is in textual JSON as property name or JSON String.

Returns:char[]: JSON quoted form of the String as char[]

asQuotedUTF8	back to summary
public byte[] asQuotedUTF8() Returns UTF-8 encoded version of JSON-quoted String. Functionally equivalent to (but more efficient than): new String(asQuotedChars()).getBytes("UTF-8"); Returns:byte[] UTF-8 encoded version of JSON-escaped String

asQuotedUTF8

back to summary

public byte[] asQuotedUTF8()

Returns UTF-8 encoded version of JSON-quoted String. Functionally equivalent to (but more efficient than):

 new String(asQuotedChars()).getBytes("UTF-8");

Returns:byte[]: UTF-8 encoded version of JSON-escaped String

asUnquotedUTF8	back to summary
public byte[] asUnquotedUTF8() Returns UTF-8 encoded version of unquoted String. Functionally equivalent to (but more efficient than): getValue().getBytes("UTF-8"); Returns:byte[] UTF-8 encoded version of String, without any escaping

asUnquotedUTF8

back to summary

public byte[] asUnquotedUTF8()

Returns UTF-8 encoded version of unquoted String. Functionally equivalent to (but more efficient than):

 getValue().getBytes("UTF-8");

Returns:byte[]: UTF-8 encoded version of String, without any escaping

charLength	back to summary
public int charLength() Returns length of the (unquoted) String as characters. Functionally equivalent to: getValue().length(); Returns:int Length of the String in characters

charLength

back to summary

public int charLength()

Returns length of the (unquoted) String as characters. Functionally equivalent to:

   getValue().length();

Returns:int: Length of the String in characters

getValue	back to summary
public String getValue() Returns unquoted String that this object represents (and offers serialized forms for) Returns:String Unquoted String

getValue

back to summary

public String getValue()

Returns unquoted String that this object represents (and offers serialized forms for)

Returns:String: Unquoted String

putQuotedUTF8 back to summary

putQuotedUTF8	back to summary
public int putQuotedUTF8(ByteBuffer buffer) throws IOException Method for appending JSON-escaped UTF-8 encoded String value into given `java.nio.ByteBuffer`, if it fits. Parameters buffer:ByteBuffer `java.nio.ByteBuffer` to append String into Returns:int Number of bytes put, if contents fit, otherwise -1 Exceptions IOException: if underlying buffer append operation fails

public int putQuotedUTF8(ByteBuffer buffer) throws IOException

Method for appending JSON-escaped UTF-8 encoded String value into given java.nio.ByteBuffer, if it fits.

Parameters

buffer:ByteBuffer: java.nio.ByteBuffer to append String into

Returns:int

Number of bytes put, if contents fit, otherwise -1

Exceptions

IOException:: if underlying buffer append operation fails

putUnquotedUTF8 back to summary

putUnquotedUTF8	back to summary
public int putUnquotedUTF8(ByteBuffer buffer) throws IOException Method for appending unquoted ('raw') UTF-8 encoded String value into given `java.nio.ByteBuffer`, if it fits. Parameters buffer:ByteBuffer `java.nio.ByteBuffer` to append String into Returns:int Number of bytes put, if contents fit, otherwise -1 Exceptions IOException: if underlying buffer append operation fails

public int putUnquotedUTF8(ByteBuffer buffer) throws IOException

Method for appending unquoted ('raw') UTF-8 encoded String value into given java.nio.ByteBuffer, if it fits.

Parameters

buffer:ByteBuffer: java.nio.ByteBuffer to append String into

Returns:int

Number of bytes put, if contents fit, otherwise -1

Exceptions

IOException:: if underlying buffer append operation fails

writeQuotedUTF8 back to summary

writeQuotedUTF8	back to summary
public int writeQuotedUTF8(OutputStream out) throws IOException Method for writing JSON-escaped UTF-8 encoded String value using given `java.io.OutputStream`. Parameters out:OutputStream `java.io.OutputStream` to write String into Returns:int Number of bytes written Exceptions IOException: if underlying stream write fails

public int writeQuotedUTF8(OutputStream out) throws IOException

Method for writing JSON-escaped UTF-8 encoded String value using given java.io.OutputStream.

Parameters

out:OutputStream: java.io.OutputStream to write String into

Returns:int

Number of bytes written

Exceptions

IOException:: if underlying stream write fails

writeUnquotedUTF8 back to summary

writeUnquotedUTF8	back to summary
public int writeUnquotedUTF8(OutputStream out) throws IOException Method for writing unescaped UTF-8 encoded String value using given `java.io.OutputStream`. Parameters out:OutputStream `java.io.OutputStream` to write String into Returns:int Number of bytes written Exceptions IOException: if underlying stream write fails

public int writeUnquotedUTF8(OutputStream out) throws IOException

Method for writing unescaped UTF-8 encoded String value using given java.io.OutputStream.

Parameters

out:OutputStream: java.io.OutputStream to write String into

Returns:int

Number of bytes written

Exceptions

IOException:: if underlying stream write fails

public Interface SerializableString

Method Summary

Method Detail