java/jakarta/websocket/EncodeException.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jakarta.websocket;

import java.io.Serial;

/**
 * Exception thrown when an encoder fails to encode an object as a WebSocket message.
 */
public class EncodeException extends Exception {

    @Serial
    private static final long serialVersionUID = 1L;

    /**
     * The object that could not be encoded.
     */
    private final Object object;

    /**
     * Creates an EncodeException with the specified object and detail message.
     *
     * @param object  The object that could not be encoded
     * @param message The detail message
     */
    public EncodeException(Object object, String message) {
        super(message);
        this.object = object;
    }

    /**
     * Creates an EncodeException with the specified object, detail message, and cause.
     *
     * @param object  The object that could not be encoded
     * @param message The detail message
     * @param cause   The underlying cause of the exception
     */
    public EncodeException(Object object, String message, Throwable cause) {
        super(message, cause);
        this.object = object;
    }

    /**
     * Returns the object that could not be encoded.
     *
     * @return The object that could not be encoded
     */
    public Object getObject() {
        return this.object;
    }
}