JsonString (embulk-spi 0.11 API)

java.lang.Object
- org.embulk.spi.json.JsonString

All Implemented Interfaces:

JsonValue
```
public final class JsonString
extends Object
implements JsonValue
```
Represents a string in JSON.
It represents the string as a String, which is the same as Embulk's STRING column type.

Since:

0.10.42

See Also:

RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format

Nested Class Summary
- Nested classes/interfaces inherited from interface org.embulk.spi.json.JsonValue
  JsonValue.EntityType

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JsonString`	`asJsonString()` Returns this value as `JsonString`.
`boolean`	`equals(Object otherObject)` Compares the specified object with this JSON string for equality.
`CharSequence`	`getChars()` Returns this JSON string as `CharSequence`.
`JsonValue.EntityType`	`getEntityType()` Returns `JsonValue.EntityType.STRING`, which is the entity type of `JsonString`.
`String`	`getString()` Returns this JSON string as `String`.
`int`	`hashCode()` Returns the hash code value for this JSON string.
`static JsonString`	`of(String value)` Returns a JSON string that is represented by the specified `String`.
`int`	`presumeReferenceSizeInBytes()` Returns the approximate size of this JSON string in bytes presumed to occupy in `Page` as a reference.
`String`	`toJson()` Returns the stringified JSON representation of this JSON string.
`Value`	`toMsgpack()` Deprecated. Do not use this method. It is to be removed at some point after Embulk v1.0.0. It is here only to ensure a migration period from MessagePack-based JSON values to new JSON values of `JsonValue`.
`String`	`toString()` Returns the string representation of this JSON string.
`static JsonString`	`withLiteral(String value, String literal)` Returns a JSON string that is represented by the specified `String`, with the specified JSON literal.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.embulk.spi.json.JsonValue
asJsonArray, asJsonBoolean, asJsonDouble, asJsonLong, asJsonNull, asJsonObject, fromMsgpack, isJsonArray, isJsonBoolean, isJsonDouble, isJsonLong, isJsonNull, isJsonObject, isJsonString

- Method Detail
  - of
```
public static JsonString of(String value)
```
    Returns a JSON string that is represented by the specified String.
    This method does not automatically apply String.intern() for value.
    
    Parameters:
    
    value - the string, not null
    
    Returns:
    
    a JSON string represented by the specified String
    
    Throws:
    
    NullPointerException - if the string is null
    
    Since:
    
    0.10.42
  - withLiteral
```
public static JsonString withLiteral(String value,
                                     String literal)
```
    Returns a JSON string that is represented by the specified String, with the specified JSON literal.
    This method does not automatically apply String.intern() for value.
    The literal is just subsidiary information used when stringifying this JSON string as JSON by toJson(). Note that the literal usually need to be quoted, for example, JsonString.withLiteral("foo\n", "\"foo\\n\"").
    
    Parameters:
    
    value - the string, not null
    
    literal - the JSON literal of the string
    
    Returns:
    
    a JSON string represented by the specified String
    
    Throws:
    
    NullPointerException - if the string is null
    
    Since:
    
    0.10.42
  - getEntityType
```
public JsonValue.EntityType getEntityType()
```
    Returns JsonValue.EntityType.STRING, which is the entity type of JsonString.
    
    Specified by:
    
    getEntityType in interface JsonValue
    
    Returns:
    
    JsonValue.EntityType.STRING, which is the entity type of JsonString
    
    Since:
    
    0.10.42
  - asJsonString
```
public JsonString asJsonString()
```
    Returns this value as JsonString.
    
    Specified by:
    
    asJsonString in interface JsonValue
    
    Returns:
    
    itself as JsonString
    
    Since:
    
    0.10.42
  - presumeReferenceSizeInBytes
```
public int presumeReferenceSizeInBytes()
```
    Returns the approximate size of this JSON string in bytes presumed to occupy in Page as a reference.
    This approximate size is used only as a threshold whether PageBuilder is flushed, or not. It is not accurate, it does not need to be accurate, and it is impossible in general to tell an accurate size that a Java object occupies in the Java heap. But, a reasonable approximate would help to keep Page performant in the Java heap.
    It is better to flush more frequently for bigger JSON value objects, less often for smaller JSON value objects, but no infinite accumulation even for empty JSON value objects.
    
    Specified by:
    
    presumeReferenceSizeInBytes in interface JsonValue
    
    Returns:
    
    the approximate size of this JSON string in bytes presumed to occupy in Page as a reference
    
    See Also:
    
    "org.embulk.spi.PageBuilderImpl#addRecord"
  - getString
```
public String getString()
```
    Returns this JSON string as String.
    
    Returns:
    
    the String representation of this JSON string
    
    Since:
    
    0.10.42
  - getChars
```
public CharSequence getChars()
```
    Returns this JSON string as CharSequence.
    
    Returns:
    
    the CharSequence representation of this JSON string
    
    Since:
    
    0.10.42
  - toJson
```
public String toJson()
```
    Returns the stringified JSON representation of this JSON string.
    If this JSON string is created with a literal by withLiteral(String, String), it returns the literal. Otherwise, it returns an escaped and quoted representation, which is valid as JSON, of this JSON string.
    
    Specified by:
    
    toJson in interface JsonValue
    
    Returns:
    
    the stringified JSON representation of this JSON string
    
    Since:
    
    0.10.42
  - toMsgpack
```
@Deprecated
public Value toMsgpack()
```
    Deprecated. Do not use this method. It is to be removed at some point after Embulk v1.0.0. It is here only to ensure a migration period from MessagePack-based JSON values to new JSON values of JsonValue.
    
    Returns the corresponding MessagePack's String value of this JSON string.
    
    Specified by:
    
    toMsgpack in interface JsonValue
    
    Returns:
    
    the corresponding MessagePack's String value of this JSON string
    
    Since:
    
    0.10.42
    
    See Also:
    
    Draft EEP: JSON Column Type
  - toString
```
public String toString()
```
    Returns the string representation of this JSON string.
    It returns an escaped and quoted representation like "string", which is valid as JSON, of this JSON string.
    It does not consider a literal by withLiteral(String, String) unlike toJson().
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this JSON string
    
    Since:
    
    0.10.42
  - equals
```
public boolean equals(Object otherObject)
```
    Compares the specified object with this JSON string for equality.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the specified object is equal to this JSON string
    
    Since:
    
    0.10.42
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this JSON string.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this JSON string
    
    Since:
    
    0.10.42

Class JsonString

Nested Class Summary

Nested classes/interfaces inherited from interface org.embulk.spi.json.JsonValue

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.embulk.spi.json.JsonValue

Method Detail

of

withLiteral

getEntityType

asJsonString

presumeReferenceSizeInBytes

getString

getChars

toJson

toMsgpack

toString

equals

hashCode