Class InvalidDataContainerException

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    InvalidListValuedDataContainerException

    public class InvalidDataContainerException
    extends Exception
    An InvalidDataContainerException indicates the non-conformance of an expected data container with the actual data container. For instance, not all mandatory output parameters are provided or contain valid values or a data container is to be flushed that does not match to the designated node.
    See Also:
    Serialized Form
    • Field Detail

      • invalidDataContainer

        protected final InputDataContainer invalidDataContainer
        The data container that has caused this exception.
      • invalidParameterName

        protected final String invalidParameterName
        The name of the parameter that has behaved unexpectedly, for instance, the parameter is mandatory but not provided by the data container.
      • instanceID

        protected final UUID instanceID
        The instance ID that the data container is expected to be of (but is not).
      • nodeID

        protected final int nodeID
        The node ID that the data container is expected to be of (but is not).
      • nodeIteration

        protected final int nodeIteration
        The node iteration that the data container is expected to be of (but is not).
    • Constructor Detail

      • InvalidDataContainerException

        public InvalidDataContainerException​(DataContainer invalidDataContainer,
                                             Throwable cause)
        Constructs a new InvalidDataContainerException raised by the designated cause while accessing/manipulating the designated data container.
        Parameters:
        invalidDataContainer - The data container that caused an exception when accessed/manipulated.
        cause - The cause that led to the constructed InvalidDataContainerException.
      • InvalidDataContainerException

        public InvalidDataContainerException​(String msg,
                                             DataContainer invalidDataContainer)
        Constructs a new InvalidDataContainerException for the designated data container with the designated arbitrary message.
        Parameters:
        msg - An arbitrary message for the exception.
        invalidDataContainer - The data container that caused an exception when accessed/manipulated.
      • InvalidDataContainerException

        public InvalidDataContainerException​(String msg,
                                             Throwable cause,
                                             DataContainer invalidDataContainer)
        Constructs a new InvalidDataContainerException raised by the designated cause while accessing/manipulating the designated data container with the designated arbitrary message.
        Parameters:
        msg - An arbitrary message for the exception.
        cause - The cause that led to the constructed InvalidDataContainerException.
        invalidDataContainer - The data container that caused an exception when accessed/manipulated.
      • InvalidDataContainerException

        public InvalidDataContainerException​(DataContainer invalidDataContainer,
                                             String invalidParameterName,
                                             Throwable cause)
        Constructs a new InvalidDataContainerException raised by the designated cause while accessing/manipulating the designated data container with the designated parameter name.
        The created exception will provide information on the parent node (instance ID, node ID, iteration).
        Parameters:
        invalidDataContainer - The data container that caused an exception when accessed/manipulated.
        invalidParameterName - The name of the parameter that does not behave like expected, for instance, it does not provide a mandatory value.
        cause - The cause that led to the constructed InvalidDataContainerException.
      • InvalidDataContainerException

        public InvalidDataContainerException​(InputDataContainer invalidDataContainer,
                                             String invalidParameterName,
                                             Throwable cause)
        Constructs a new InvalidDataContainerException raised by the designated cause while accessing/manipulating the designated data container with the designated parameter name.
        The created exception will not provide any information on the parent node (instance ID, node ID, iteration).
        Parameters:
        invalidDataContainer - The data container that caused an exception when accessed/manipulated.
        invalidParameterName - The name of the parameter that does not behave like expected, for instance, it does not provide a mandatory value.
        cause - The cause that led to the constructed InvalidDataContainerException.
      • InvalidDataContainerException

        public InvalidDataContainerException​(InputDataContainer invalidDataContainer,
                                             String invalidParameterName)
        Constructs a new InvalidDataContainerException to indicate that the designated data container does not contain the expected data.
        The created exception will not provide any information on the parent node (instance ID, node ID, iteration).
        Parameters:
        invalidDataContainer - The erroneous data container.
        invalidParameterName - The name of the parameter that does not behave like expected, for instance, it does not provide a mandatory value.
      • InvalidDataContainerException

        public InvalidDataContainerException​(String mandatoryParamName)
        Constructs a new InvalidDataContainerException to indicate that no data container is provided but a mandatory (instance input) parameter exists. The created exception will not provide any information on the parent node (instance ID, node ID, iteration).
        Parameters:
        mandatoryParamName - The name of the mandatory (instance input) parameter that needs to be provided but is not due to the absence of a data container.
      • InvalidDataContainerException

        public InvalidDataContainerException​(InputDataContainer invalidDataContainer,
                                             UUID instanceID,
                                             int nodeID,
                                             int nodeIteration)
        Constructs a new InvalidDataContainerException to indicate that the designated data container does not correspond to the node information when flushed.
        Parameters:
        invalidDataContainer - The data container that does not correspond to the node information when flushed.
        instanceID - The instance ID that the data container is expected to be of (but is not).
        nodeID - The node ID that the data container is expected to be of (but is not).
        nodeIteration - The node iteration that the data container is expected to be of (but is not).
    • Method Detail

      • getInvalidDataContainer

        public InputDataContainer getInvalidDataContainer()
        Gets the data container that caused this exception or null if this exception is caused by a missing data container.
        Returns:
        The invalid data container or null if this exception is caused by a missing data container.
      • getInvalidParameterName

        public String getInvalidParameterName()
        Gets the name of the parameter that has behaved unexpectedly or null in case this exception has been raised due to wrong node information when flushed.
        Returns:
        The invalid parameter name or null.
      • getInstanceID

        public UUID getInstanceID()
        Gets the instance ID that the data container is expected to be of (but is not) or null in case this exception has not been raised due to wrong node information when flushed.
        Returns:
        The ID of the instance that the data container is expected to be of (but is not) or null.
      • getNodeID

        public int getNodeID()
        Gets the node ID that the data container is expected to be of (but is not) or CommonConstants.INT_ID_NOT_EXISTING in case this exception has not been raised due to wrong node information when flushed.
        Returns:
        The node ID that the data container is expected to be of (but is not) or CommonConstants.INT_ID_NOT_EXISTING.
      • getNodeIteration

        public int getNodeIteration()
        Gets the node iteration that the data container is expected to be of (but is not) or CommonConstants.INT_ID_NOT_EXISTING in case this exception has not been raised due to wrong node information when flushed.
        Returns:
        The node iteration that the data container is expected to be of (but is not) or CommonConstants.INT_ID_NOT_EXISTING.