com.github.dannil.scbjavaclient.format.json

Interface IJsonTableFormat

All Known Implementing Classes:

JsonAPITableFormat

public interface IJsonTableFormat

Interface for JSON table format. All implementing classes should specify an instance variable which contains the JSON which should be operated on by the methods.

Author:

Daniel Nilsson

Method Summary

Modifier and Type	Method and Description
List<String>	getCodes() Extracts the codes from the JSON.
Map<String,Collection<String>>	getInputs() Extracts the codes and their respective values from the JSON.
List<String>	getValues(String code) Extracts the values for a code from the JSON.

Method Detail

getInputs

Map<String,Collection<String>> getInputs()

Extracts the codes and their respective values from the JSON.

Returns:

a collection of all codes and their respective values

getValues

List<String> getValues(String code)
                throws IllegalArgumentException

Extracts the values for a code from the JSON.

Parameters:

code - the code

Returns:

a list of values

Throws:

IllegalArgumentException - if the JSON doesn't contain the code

getCodes

List<String> getCodes()
               throws IllegalArgumentException

Extracts the codes from the JSON.

Returns:

a list of codes

Throws:

IllegalArgumentException - if the JSON doesn't contain codes