BuilderLimits

java.lang.Object
- org.json.stream.BuilderLimits

All Implemented Interfaces:

java.lang.Cloneable
```
public class BuilderLimits
extends java.lang.Object
implements java.lang.Cloneable
```
Builder limits, based on similar limits used in some XML parsers.

Constructor Summary

Constructors
Constructor and Description

BuilderLimits()
Create a new BuilderLimits class with large, but bounded, limits on object building.

Constructors
Constructor and Description
`BuilderLimits()` Create a new `BuilderLimits` class with large, but bounded, limits on object building.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BuilderLimits`	`clone()` Clone this `BuilderLimits` object for customisation, or to avoid mutation from outside code.
`boolean`	`equals(java.lang.Object o)`
`int`	`getContentNodes()` Total number of child nodes per object or array.
`int`	`getExponentDigits()` The maximum number of exponent digits in a number.
`LimitFilter`	`getFilter()` Soft filtering for any object, array, or value that passes the other limits provided.
`int`	`getKeyLength()` The maximum length of any key.
`int`	`getMantissaDigits()` The maximum number of mantissa digits in a number.
`int`	`getNestingDepth()` Total nesting depth of objects or arrays.
`int`	`getStringLength()` The maximum length of any string value.
`int`	`hashCode()`
`static BuilderLimits`	`secureDefaults()` Return a `BuilderLimits` object that contains some limits for secure processing.
`void`	`setContentNodes(int contentNodes)` Total number of child nodes per object or array.
`void`	`setExponentDigits(int exponentDigits)` The maximum number of exponent digits in a number.
`void`	`setFilter(LimitFilter filter)` Soft filtering for any object, array, or value that passes the other limits provided.
`void`	`setKeyLength(int keyLength)` The maximum length of any key.
`void`	`setMantissaDigits(int mantissaDigits)` The maximum number of mantissa digits in a number.
`void`	`setNestingDepth(int nestingDepth)` Total nesting depth of objects or arrays.
`void`	`setStringLength(int stringLength)` The maximum length of any string value.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - BuilderLimits
```
public BuilderLimits()
```
    Create a new BuilderLimits class with large, but bounded, limits on object building.
- Method Detail
  - setKeyLength
```
public void setKeyLength(int keyLength)
```
    The maximum length of any key.
    
    Parameters:
    
    keyLength - the maximum length of any key
  - setStringLength
```
public void setStringLength(int stringLength)
```
    The maximum length of any string value.
    
    Parameters:
    
    stringLength - the maximum length of any string value
  - setMantissaDigits
```
public void setMantissaDigits(int mantissaDigits)
```
    The maximum number of mantissa digits in a number.
    
    Parameters:
    
    mantissaDigits - the maximum number of mantissa digits of any number value
  - setExponentDigits
```
public void setExponentDigits(int exponentDigits)
```
    The maximum number of exponent digits in a number.
    
    Parameters:
    
    exponentDigits - the maximum number of exponent digits of any number value
  - setContentNodes
```
public void setContentNodes(int contentNodes)
```
    Total number of child nodes per object or array.
    
    Parameters:
    
    contentNodes - the total number of values, arrays, and objects for any given container array or object
  - setNestingDepth
```
public void setNestingDepth(int nestingDepth)
```
    Total nesting depth of objects or arrays.
    
    Parameters:
    
    nestingDepth - the maximum nesting depth within any array or object
  - getKeyLength
```
public int getKeyLength()
```
    The maximum length of any key.
    
    Returns:
    
    the maximum length of any key
  - getStringLength
```
public int getStringLength()
```
    The maximum length of any string value.
    
    Returns:
    
    the maximum length of any string value
  - getMantissaDigits
```
public int getMantissaDigits()
```
    The maximum number of mantissa digits in a number.
    
    Returns:
    
    the maximum number of mantissa digits of any number value
  - getExponentDigits
```
public int getExponentDigits()
```
    The maximum number of exponent digits in a number.
    
    Returns:
    
    the maximum number of exponent digits of any number value
  - getContentNodes
```
public int getContentNodes()
```
    Total number of child nodes per object or array.
    
    Returns:
    
    the total number of values, arrays, and objects for any given container array or object
  - getNestingDepth
```
public int getNestingDepth()
```
    Total nesting depth of objects or arrays.
    
    Returns:
    
    the maximum nesting depth within any array or object
  - getFilter
```
public LimitFilter getFilter()
```
    Soft filtering for any object, array, or value that passes the other limits provided. If the filter rejects the value, it will be skipped, along with any nested content, and parsing continues.
    
    Returns:
    
    the filter for accepting or rejecting values
  - setFilter
```
public void setFilter(LimitFilter filter)
```
    Soft filtering for any object, array, or value that passes the other limits provided. If the filter rejects the value, it will be skipped and parsing continues.
    
    Parameters:
    
    filter - the filter for creating objects, arrays, or values
  - secureDefaults
```
public static BuilderLimits secureDefaults()
```
    Return a BuilderLimits object that contains some limits for secure processing. These can be customised as needed.
    The limits specify:
    - Number limits sufficient for parsing Long and Double values. These conform to the I-JSON requirements (RFC 7493)
    - Key length limits sufficient for most typical requirements, similar to XML attribute name limits
    - String length sufficient to fit in a Java String object
    - Content node limits sufficient for most typical requirements, similar to XML content node limits
    - Nesting level limits sufficient to avoid stack limits when using recursive algorithms
    Returns:
    
    a BuilderLimits object with secure processing limits
  - clone
```
public BuilderLimits clone()
```
    Clone this BuilderLimits object for customisation, or to avoid mutation from outside code.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this BuilderLimits object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BuilderLimits

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BuilderLimits

Method Detail

setKeyLength

setStringLength

setMantissaDigits

setExponentDigits

setContentNodes

setNestingDepth

getKeyLength

getStringLength

getMantissaDigits

getExponentDigits

getContentNodes

getNestingDepth

getFilter

setFilter

secureDefaults

clone

equals

hashCode

toString