Package com.networknt.schema.keyword

Class DiscriminatorState

java.lang.Object
com.networknt.schema.keyword.DiscriminatorState
public class DiscriminatorState extends Object
Discriminator state for an instance location.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DiscriminatorState()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDiscriminatingValue()
    Gets the discriminating value, which is the value in the payload corresponding with the property name.
    String
    getMappedSchema()
    Gets the mapped schema which is the discriminating value mapped to the schema name or uri.
    String
    getMatchedSchema()
    Gets the matched schema $ref.
    String
    getPropertyName()
    Gets the property name defined in the discriminator keyword schema.
    boolean
    hasDiscriminatingValue()
    Returns true if the discriminating value is found in the payload corresponding to the property name.
    boolean
    hasMatchedSchema()
    Returns true if there was a schema that matched the discriminating value.
    boolean
    isExplicitMapping()
    Gets whether the mapping is explicit using the mappings on the discriminator keyword.
    boolean
    matches(String refSchema)
    Determines if there is a match of the mapped schema to the ref and update the matched schema if there is a match.
    void
    setDiscriminatingValue(String discriminatingValue)
    Sets the discriminating value, which is the value in the payload corresponding with the property name.
    void
    setExplicitMapping(boolean explicitMapping)
    Sets whether the mapping is explicit using the mappings on the discriminator keyword.
    void
    setMappedSchema(String mappedSchema)
    Sets the mapped schema which is the discriminating value mapped to the schema name or uri.
    void
    setMatchedSchema(String matchedSchema)
    Sets the matched schema $ref.
    void
    setPropertyName(String propertyName)
    Sets the property name defined in the discriminator keyword schema.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DiscriminatorState

      public DiscriminatorState()

  • Method Details

    • matches

      public boolean matches(String refSchema)
      Determines if there is a match of the mapped schema to the ref and update the matched schema if there is a match.
      Parameters:
      refSchema - the $ref value
      Returns:
      true if there is a match

    • getPropertyName

      public String getPropertyName()
      Gets the property name defined in the discriminator keyword schema.
      Returns:

    • setPropertyName

      public void setPropertyName(String propertyName)
      Sets the property name defined in the discriminator keyword schema.
      Parameters:
      propertyName - the property name

    • getDiscriminatingValue

      public String getDiscriminatingValue()
      Gets the discriminating value, which is the value in the payload corresponding with the property name.
      Returns:
      the discriminating value

    • setDiscriminatingValue

      public void setDiscriminatingValue(String discriminatingValue)
      Sets the discriminating value, which is the value in the payload corresponding with the property name.
      Parameters:
      discriminatingValue -

    • hasDiscriminatingValue

      public boolean hasDiscriminatingValue()
      Returns true if the discriminating value is found in the payload corresponding to the property name.
      Returns:
      true if the discriminating value is found in the payload corresponding to the property name

    • getMappedSchema

      public String getMappedSchema()
      Gets the mapped schema which is the discriminating value mapped to the schema name or uri.
      Returns:
      the mapped schema

    • setMappedSchema

      public void setMappedSchema(String mappedSchema)
      Sets the mapped schema which is the discriminating value mapped to the schema name or uri.
      Parameters:
      mappedSchema - the mapped schema

    • isExplicitMapping

      public boolean isExplicitMapping()
      Gets whether the mapping is explicit using the mappings on the discriminator keyword.
      Returns:
      true if the mapping is explicitly mapped using mappings

    • setExplicitMapping

      public void setExplicitMapping(boolean explicitMapping)
      Sets whether the mapping is explicit using the mappings on the discriminator keyword.
      Parameters:
      explicitMapping - true if explicitly mapped using mappings

    • setMatchedSchema

      public void setMatchedSchema(String matchedSchema)
      Sets the matched schema $ref.
      Parameters:
      matchedSchema - the matched schema $ref

    • getMatchedSchema

      public String getMatchedSchema()
      Gets the matched schema $ref.
      Returns:
      the matched schema $ref

    • hasMatchedSchema

      public boolean hasMatchedSchema()
      Returns true if there was a schema that matched the discriminating value.

      If the discriminating value does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Therefore if this returns false validation should fail.

      4.8.25.4 Examples

      Returns:
      true if there was a schema that matched the discriminating value.