Improve UnknownObject observability
[bgpcep.git] / pcep / spi / src / main / java / org / opendaylight / protocol / pcep / spi / UnknownObject.java
1 /*
2  * Copyright (c) 2013 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.protocol.pcep.spi;
9
10 import static java.util.Objects.requireNonNull;
11
12 import com.google.common.base.MoreObjects;
13 import java.util.Collections;
14 import java.util.List;
15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcep.error.object.ErrorObjectBuilder;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.Errors;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcerr.message.pcerr.message.ErrorsBuilder;
19
20 /**
21  * Placeholder object. This object should be injected by in positions where an object is either completely unknown or
22  * has failed semantic validation.
23  */
24 public final class UnknownObject implements Object {
25     private final Object invalidObject;
26     private final Errors error;
27     private final PCEPErrors err;
28
29     public UnknownObject(final PCEPErrors error) {
30         this(error, null);
31     }
32
33     public UnknownObject(final PCEPErrors error, final Object invalidObject) {
34         err = requireNonNull(error);
35         this.invalidObject = invalidObject;
36         this.error = new ErrorsBuilder()
37             .setErrorObject(new ErrorObjectBuilder().setType(err.getErrorType()).setValue(err.getErrorValue()).build())
38             .build();
39     }
40
41     public List<Errors> getErrors() {
42         return Collections.singletonList(error);
43     }
44
45     public PCEPErrors getError() {
46         return err;
47     }
48
49     public Object getInvalidObject() {
50         return invalidObject;
51     }
52
53     @Override
54     public Class<Object> implementedInterface() {
55         return Object.class;
56     }
57
58     @Override
59     public Boolean getIgnore() {
60         return Boolean.FALSE;
61     }
62
63     @Override
64     public Boolean getProcessingRule() {
65         return Boolean.FALSE;
66     }
67
68     @Override
69     public String toString() {
70         return MoreObjects.toStringHelper(UnknownObject.class).omitNullValues()
71             .add("error", error)
72             .add("object", invalidObject)
73             .toString();
74     }
75 }