Class StreamWriteConstraints

Method Details

• overrideDefaultStreamWriteConstraints

  public static void overrideDefaultStreamWriteConstraints(StreamWriteConstraints streamWriteConstraints)

  Override the default StreamWriteConstraints. These defaults are only used when JsonFactory instances are not configured with their own StreamWriteConstraints.

  Library maintainers should not set this as it will affect other code that uses Jackson. Library maintainers who want to configure StreamWriteConstraints for the Jackson usage within their lib should create ObjectMapper instances that have a JsonFactory instance with the required StreamWriteConstraints.

  This method is meant for users delivering applications. If they use this, they set it when they start their application to avoid having other code initialize their mappers before the defaults are overridden.

  Parameters:

  streamWriteConstraints - new default for StreamWriteConstraints (a null value will reset to built-in default)

  See Also:

  • defaults()
  • builder()

• builder

  public static StreamWriteConstraints.Builder builder()

• defaults

  public static StreamWriteConstraints defaults()

  Returns:

  the default StreamWriteConstraints (when none is set on the JsonFactory explicitly)

  See Also:

  • overrideDefaultStreamWriteConstraints(StreamWriteConstraints)

• rebuild

  public StreamWriteConstraints.Builder rebuild()

  Returns:

  New StreamWriteConstraints.Builder initialized with settings of this constraints instance

• getMaxNestingDepth

  public int getMaxNestingDepth()

  Accessor for maximum depth. see StreamWriteConstraints.Builder.maxNestingDepth(int) for details.

  Returns:

  Maximum allowed depth

• validateNestingDepth

  public void validateNestingDepth(int depth) throws StreamConstraintsException

  Convenience method that can be used to verify that the nesting depth does not exceed the maximum specified by this constraints object: if it does, a StreamConstraintsException is thrown.

  Parameters:

  depth - count of unclosed objects and arrays

  Throws:

  StreamConstraintsException - If depth exceeds maximum

• _constructException

  protected StreamConstraintsException _constructException(String msgTemplate, Object... args) throws StreamConstraintsException

  Throws:

  StreamConstraintsException

• _constrainRef

  protected String _constrainRef(String method)