com.screenscraper.util.parsing

Class JSONSort

java.lang.Object

com.screenscraper.util.parsing.JSONSort

public class JSONSort
extends java.lang.Object

Simple class to sort JSON objects so keys are alphabetized. This can help with displaying and caching (to eliminate duplicates) Since version 7.0.9a this also supports Gson objects

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
JSONSort(java.util.Comparator<java.lang.String> keyComparator) Creates the sorter
JSONSort(java.util.Comparator<java.lang.String> keyComparator, boolean prettyOutput) Creates the sorter
JSONSort(java.util.Comparator<java.lang.String> keyComparator, java.util.Comparator<java.lang.Object> arrayValueComparator) Creates the sorter
JSONSort(java.util.Comparator<java.lang.String> keyComparator, java.util.Comparator<java.lang.Object> arrayValueComparator, boolean prettyOutput) Creates the sorter

Method Summary

Modifier and Type	Method and Description
boolean	isPrettyOutput() Returns the PrettyOutput for the object
java.lang.String	parseAndSort(java.lang.String jsonString) Takes the JSON string as input and parses it, then sorts it and returns the new output
void	setPrettyOutput(boolean prettyOutput) Sets the PrettyOutput for the object
java.lang.String	toSortedString(java.lang.Object obj) Converts the object to a JSON string, but it will be sorted according to the comparators of this object

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONSort

public JSONSort(@NotNull
                java.util.Comparator<java.lang.String> keyComparator)

Creates the sorter

Parameters:

keyComparator - The comparator for comparing keys

JSONSort

public JSONSort(@NotNull
                java.util.Comparator<java.lang.String> keyComparator,
                boolean prettyOutput)

Creates the sorter

Parameters:

keyComparator - The comparator for comparing keys

prettyOutput - True if output should be pretty (new lines, spacing, etc...) or false for a more compact JSON string

JSONSort

public JSONSort(@NotNull
                java.util.Comparator<java.lang.String> keyComparator,
                @Nullable
                java.util.Comparator<java.lang.Object> arrayValueComparator)

Creates the sorter

Parameters:

keyComparator - The comparator for comparing keys

arrayValueComparator - The comparator for comparing values in an array (null means leaves arrays in the order they are in)

JSONSort

public JSONSort(@NotNull
                java.util.Comparator<java.lang.String> keyComparator,
                @Nullable
                java.util.Comparator<java.lang.Object> arrayValueComparator,
                boolean prettyOutput)

Creates the sorter

Parameters:

keyComparator - The comparator for comparing keys

arrayValueComparator - The comparator for comparing values in an array (null means leaves arrays in the order they are in)

prettyOutput - True if output should be pretty (new lines, spacing, etc...) or false for a more compact JSON string

Method Detail

isPrettyOutput

public boolean isPrettyOutput()

Returns the PrettyOutput for the object

Returns:

The PrettyOutput for the object

setPrettyOutput

public void setPrettyOutput(boolean prettyOutput)

Sets the PrettyOutput for the object

Parameters:

prettyOutput - The new value for PrettyOutput

parseAndSort

@NotNull
public java.lang.String parseAndSort(@NotNull
                                               java.lang.String jsonString)

Takes the JSON string as input and parses it, then sorts it and returns the new output

Parameters:

jsonString - The json to parse

Returns:

The sorted JSON string

Since:

7.0.9a

toSortedString

@NotNull
public java.lang.String toSortedString(@Nullable
                                                 java.lang.Object obj)

Converts the object to a JSON string, but it will be sorted according to the comparators of this object

Parameters:

obj - The object to sort (must be a valid JSON type -- JSONObject, JSONArray, String, Boolean, Number) from org.json.*

Returns:

The sorted string of JSON