Removed unused PCEPDocumentedException from object parsers.
[bgpcep.git] / pcep / impl / src / main / java / org / opendaylight / protocol / pcep / impl / object / PCEPMetricObjectParser.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.impl.object;
9
10 import java.util.BitSet;
11
12 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
13 import org.opendaylight.protocol.pcep.spi.TlvHandlerRegistry;
14 import org.opendaylight.protocol.util.ByteArray;
15 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Object;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.ObjectHeader;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Tlv;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.Metric;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.metric.object.MetricBuilder;
21
22 import com.google.common.primitives.UnsignedBytes;
23
24 /**
25  * Parser for {@link Metric}
26  */
27 public class PCEPMetricObjectParser extends AbstractObjectWithTlvsParser<MetricBuilder> {
28
29         public static final int CLASS = 6;
30
31         public static final int TYPE = 1;
32
33         /*
34          * lengths of fields in bytes
35          */
36         private static final int FLAGS_F_LENGTH = 1;
37         private static final int TYPE_F_LENGTH = 1;
38         private static final int METRIC_VALUE_F_LENGTH = 4;
39
40         /*
41          * offsets of fields in bytes
42          */
43         private static final int FLAGS_F_OFFSET = 2;
44         private static final int TYPE_F_OFFSET = FLAGS_F_OFFSET + FLAGS_F_LENGTH;
45         private static final int METRIC_VALUE_F_OFFSET = TYPE_F_OFFSET + TYPE_F_LENGTH;
46
47         /*
48          * flags offsets inside flags field in bits
49          */
50         private static final int C_FLAG_OFFSET = 6;
51         private static final int B_FLAG_OFFSET = 7;
52
53         private static final int SIZE = METRIC_VALUE_F_OFFSET + METRIC_VALUE_F_LENGTH;
54
55         public PCEPMetricObjectParser(final TlvHandlerRegistry tlvReg) {
56                 super(tlvReg);
57         }
58
59         @Override
60         public Metric parseObject(final ObjectHeader header, final byte[] bytes) throws PCEPDeserializerException {
61                 if (bytes == null || bytes.length == 0) {
62                         throw new IllegalArgumentException("Array of bytes is mandatory. Can't be null or empty.");
63                 }
64                 if (bytes.length != SIZE) {
65                         throw new PCEPDeserializerException("Wrong length of array of bytes. Passed: " + bytes.length + "; Expected: " + SIZE + ".");
66                 }
67                 final byte[] flagBytes = { bytes[FLAGS_F_OFFSET] };
68                 final BitSet flags = ByteArray.bytesToBitSet(flagBytes);
69                 final MetricBuilder builder = new MetricBuilder();
70                 builder.setIgnore(header.isIgnore());
71                 builder.setProcessingRule(header.isProcessingRule());
72                 builder.setBound(flags.get(B_FLAG_OFFSET));
73                 builder.setComputed(flags.get(C_FLAG_OFFSET));
74                 builder.setMetricType((short) UnsignedBytes.toInt(bytes[TYPE_F_OFFSET]));
75                 builder.setValue(new Float32(ByteArray.subByte(bytes, METRIC_VALUE_F_OFFSET, METRIC_VALUE_F_LENGTH)));
76                 return builder.build();
77         }
78
79         @Override
80         public void addTlv(final MetricBuilder builder, final Tlv tlv) {
81                 // No tlvs defined
82         }
83
84         @Override
85         public byte[] serializeObject(final Object object) {
86                 if (!(object instanceof Metric)) {
87                         throw new IllegalArgumentException("Wrong instance of PCEPObject. Passed " + object.getClass() + ". Needed MetricObject.");
88                 }
89                 final Metric mObj = (Metric) object;
90                 final byte[] retBytes = new byte[SIZE];
91                 final BitSet flags = new BitSet(FLAGS_F_LENGTH * Byte.SIZE);
92                 flags.set(C_FLAG_OFFSET, mObj.isComputed());
93                 flags.set(B_FLAG_OFFSET, mObj.isBound());
94                 ByteArray.copyWhole(ByteArray.bitSetToBytes(flags, FLAGS_F_LENGTH), retBytes, FLAGS_F_OFFSET);
95                 retBytes[TYPE_F_OFFSET] = UnsignedBytes.checkedCast(mObj.getMetricType());
96                 System.arraycopy(mObj.getValue().getValue(), 0, retBytes, METRIC_VALUE_F_OFFSET, METRIC_VALUE_F_LENGTH);
97                 return retBytes;
98         }
99
100         @Override
101         public int getObjectType() {
102                 return TYPE;
103         }
104
105         @Override
106         public int getObjectClass() {
107                 return CLASS;
108         }
109 }