software.amazon.smithy.model.traits

Class TraitDefinition.BreakingChangeRule

java.lang.Object

software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule

All Implemented Interfaces:

ToNode

Enclosing class:

TraitDefinition

public static final class TraitDefinition.BreakingChangeRule
extends java.lang.Object
implements ToNode

Represents an individual trait diff rule to define backward compatibility rules.

Constructor Summary

Constructors

Constructor and Description
BreakingChangeRule(NodePointer path, Severity severity, TraitDefinition.ChangeType change, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static TraitDefinition.BreakingChangeRule	fromNode(Node node) Creates a TraitDiffRule from a Node.
TraitDefinition.ChangeType	getChange()
NodePointer	getDefaultedPath()
Severity	getDefaultedSeverity()
java.util.Optional<java.lang.String>	getMessage()
java.util.Optional<NodePointer>	getPath()
java.util.Optional<Severity>	getSeverity()
int	hashCode()
Node	toNode() Converts a value to a Node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BreakingChangeRule

public BreakingChangeRule(NodePointer path,
                          Severity severity,
                          TraitDefinition.ChangeType change,
                          java.lang.String message)

Method Detail

getPath

public java.util.Optional<NodePointer> getPath()

getDefaultedPath

public NodePointer getDefaultedPath()

getSeverity

public java.util.Optional<Severity> getSeverity()

getDefaultedSeverity

public Severity getDefaultedSeverity()

getChange

public TraitDefinition.ChangeType getChange()

getMessage

public java.util.Optional<java.lang.String> getMessage()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

fromNode

public static TraitDefinition.BreakingChangeRule fromNode(Node node)

Creates a TraitDiffRule from a Node.

Parameters:

node - Node to deserialize.

Returns:

Returns the created TraitDiffRule.

Throws:

ExpectationNotMetException - if the node is invalid.