JsonTemplate (com.github.json-template:jsontemplate 0.2.1 API)

java.lang.Object
- com.github.jsontemplate.JsonTemplate

```
public class JsonTemplate
extends Object
```
JsonTemplate is for generating a json string based on a schema specification.
For example, to have a json like the following one
```
 {
   "city" : "Utrecht",
   "street" : "Musicallaan",
   "number" : 413
 }
```
You can use the following code snippet to create the expected json.
```
 String template = "{city:Utrecht, street:Musicallaan, number:413}"
 String json = new JsonTemplate(template).prettyString();
```
If you need only a json which is schema compatible, the template can be specified as:
```
 String template = "{city:@s, street:@s, number:@i}"
```
@s, @i refer to value producers.
另请参阅:

JsonTemplate GitHub

构造器概要

构造器
构造器和说明

JsonTemplate(String template)

构造器
构造器和说明
`JsonTemplate(String template)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`compactString()` Produces a compact json string.
`String`	`getTemplate()` Returns the input json template
`String`	`prettyString()` Produces a json string with identations.
`JsonTemplate`	`withDefaultTypeName(String typeName)` Registers the default type name.
`JsonTemplate`	`withValueProducer(IValueProducer valueProducer)` Registers a node producer.
`JsonTemplate`	`withVar(String variableName, Object variable)` Registers a variable which is used in the template.
`JsonTemplate`	`withVars(Map<String,Object> variables)` Registers a map of variables which are used in the template.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - JsonTemplate
```
public JsonTemplate(String template)
```
- 方法详细资料
  - withVar
```
public JsonTemplate withVar(String variableName,
                            Object variable)
```
    Registers a variable which is used in the template. Example:
```
 String json = new JsonTemplate("{city:$cityVar}")
                .withVar("cityVar", "Utrecht").compactString();
 
```
    In the end, the value of json is {"city":"Utrecht"}
    The variable can be set as a single parameter. For example, {city:@s($var)} If var refers to a collection or an array, e.g., {"Amsterdam", "Utrecht"}. The template is equal to the list parameter form {city:@s(Amsterdam, Utrecht)} which selects one value from the list parameter.
    If var refers to a map, e.g., mapVar.put("length", 10). The template is equal to the map parameter form {city:@s(length=10)}.
    Otherwise, the string representation of the variable is used.
    The variable can be set as an element of the list parameter. For example, {city:@s(Amsterdam, $anotherCity)}. No matter what the type of $anotherCity is, the string representation of the variable is always used.
    The variable can be set as a value in the map parameter. For example, {city:@s(length=$expectedLength)}. No matter what the type of $expectedLength is, the string representation of the variable is always used.
    The variable can be set as a json value. For example, {city:$cityVar}
    If $cityVar is null, it is converted to a json null value.
    If $cityVar is an integer or a float, it is converted to a json numeric value.
    If $cityVar is a boolean, it is converted to a json boolean value.
    If $cityVar is an array or a collection, it is converted to a json array.
    If $cityVar is a map, it is converted to a json object.
    Otherwise, it is converted to a json string object.
    参数:
    
    variableName - name of the variable without the leading '$'
    
    variable - variable value
    
    返回:
    
    itself
  - withVars
```
public JsonTemplate withVars(Map<String,Object> variables)
```
    Registers a map of variables which are used in the template.
    
    参数:
    
    variables - map of variables
    
    返回:
    
    itself
    
    另请参阅:
    
    withVar(String, Object)
  - withValueProducer
```
public JsonTemplate withValueProducer(IValueProducer valueProducer)
```
    Registers a node producer. The node producer can use a new type name and it can also overwrite a pre-installed one.
    The pre-installed node producers are:
    参数:
    
    valueProducer - the customized value producer
    
    返回:
    
    itself
  - withDefaultTypeName
```
public JsonTemplate withDefaultTypeName(String typeName)
```
    Registers the default type name. If the type of a json value is not specified in the template. It searches through its parents util it finds a parent who has as default type or it reaches the root. If the default type of the root is not explicitly specified. The default type is SmartValueProducer.
    Example:
```
     { obj1: @i{fieldA}, obj2: {fieldB} }
 
```
    the default type of root is not specified, by default it is @smart
    the default type of obj1 is specified, it is @i
    the default type of obj2 is not specified, it searches its parent and finds the default type @smart
    参数:
    
    typeName - the default type name
    
    返回:
    
    itself
  - getTemplate
```
public String getTemplate()
```
    Returns the input json template
    
    返回:
    
    the original json template
  - compactString
```
public String compactString()
```
    Produces a compact json string.
    
    返回:
    
    a compact json string
  - prettyString
```
public String prettyString()
```
    Produces a json string with identations.
    
    返回:
    
    a json string with identation
    
    另请参阅:
    
    compactString()

类 JsonTemplate

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

JsonTemplate

方法详细资料

withVar

withVars

withValueProducer

withDefaultTypeName

getTemplate

compactString

prettyString