Clean up DataContainerCodecContext exception handling
[mdsal.git] / binding / mdsal-binding-dom-codec-api / src / main / java / org / opendaylight / mdsal / binding / dom / codec / api / IncorrectNestingException.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.mdsal.binding.dom.codec.api;
9
10 import com.google.common.annotations.Beta;
11 import java.io.Serial;
12 import org.eclipse.jdt.annotation.NonNull;
13
14 /**
15  * Thrown where incorrect nesting of data structures was detected and was caused by user. This typically indicates
16  * that class structure encountered could not have possibly been constructed according to the rules understood by the
17  * codec.
18  */
19 @Beta
20 public class IncorrectNestingException extends IllegalArgumentException {
21     @Serial
22     private static final long serialVersionUID = 1L;
23
24     public IncorrectNestingException(final String message) {
25         super(message);
26     }
27
28     public IncorrectNestingException(final String message, final Object... args) {
29         this(message.formatted(args));
30     }
31
32     @Deprecated(since = "12.0.0", forRemoval = true)
33     public static @NonNull IncorrectNestingException create(final String message, final Object... args) {
34         return new IncorrectNestingException(message, args);
35     }
36 }