net.openhft.chronicle.core.io

Class InvalidMarshallableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.openhft.chronicle.core.io.InvalidMarshallableException

All Implemented Interfaces:

Serializable

public class InvalidMarshallableException
extends RuntimeException

InvalidMarshallableException is thrown to indicate that an object being serialized (marshalled) or deserialized (unmarshalled) is in an invalid state. This could happen if the object fails to meet the required constraints, such as a mandatory field being null, a value being out of its valid range, or any other violation of the integrity rules.

This exception is particularly useful in scenarios where objects are being converted to or from a different representation, such as serialization, and you need to ensure that the object adheres to its contract or the defined schema.

It can also be used in conjunction with the Validatable interface. When an object implementing Validatable is validated using its validate method, this exception can be thrown if the object does not meet the defined criteria.

Example usage:

 public class MyObject implements Validatable {
     private String someField;

      @Override
     public void validate() {
         if (someField == null) {
             throw new InvalidMarshallableException("someField cannot be null");
         }
         // ... other validations ...
     }
 }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidMarshallableException(String msg) Constructs an InvalidMarshallableException with the specified detail message.

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidMarshallableException

public InvalidMarshallableException(String msg)

Constructs an InvalidMarshallableException with the specified detail message. The detail message is meant to provide more information on why the exception was thrown, typically indicating which validation failed.

Parameters:

msg - The detail message, which is saved for later retrieval by the Throwable.getMessage() method.