blob: 380fb42ef25d26f1b318ee254f7fac124fc60294 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*
* Copyright 2015 Open Networking Laboratory
*
* Licensed 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 org.onosproject.pcepio.protocol;
import org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.pcepio.exceptions.PcepParseException;
import org.onosproject.pcepio.types.PcepObjectHeader;
/**
* Abstraction of an entity providing PCEP Metric Object.
*/
public interface PcepMetricObject {
/**
* Returns Metric value in Metric Object.
*
* @return Metric value
*/
int getMetricVal();
/**
* Sets Metric value in Metric Object with specified value.
*
* @param value Metric value
*/
void setMetricVal(int value);
/**
* Returns Y flag in Metric Object.
*
* @return Y flag in Metric Object
*/
byte getYFlag();
/**
* Sets Y flag in Metric Object with specified value.
*
* @param value Y flag
*/
void setYFlag(byte value);
/**
* Returns C flag in Metric Object.
*
* @return C flag in Metric Object
*/
boolean getCFlag();
/**
* Sets C flag in Metric Object with specified value.
*
* @param value C flag
*/
void setCFlag(boolean value);
/**
* Returns B flag in Metric Object.
*
* @return B flag in Metric Object
*/
boolean getBFlag();
/**
* Sets B flag in Metric Object with specified value.
*
* @param value B flag
*/
void setBFlag(boolean value);
/**
* Returns BType field in Metric Object.
*
* @return BType field in Metric Object
*/
byte getBType();
/**
* Sets BType field in Metric Object with specified value.
*
* @param value BType field
*/
void setBType(byte value);
/**
* Writes the Metric Object into channel buffer.
*
* @param bb channel buffer
* @return Returns the writerIndex of this buffer
* @throws PcepParseException while writing METRIC object into Channel Buffer.
*/
int write(ChannelBuffer bb) throws PcepParseException;
/**
* Builder interface with get and set functions to build Metric object.
*/
interface Builder {
/**
* Builds Metric Object.
*
* @return Metric Object
* @throws PcepParseException when mandatory object is not set
*/
PcepMetricObject build() throws PcepParseException;
/**
* Returns Metric object header.
*
* @return Metric object header
*/
PcepObjectHeader getMetricObjHeader();
/**
* Sets Metric object header and returns its builder.
*
* @param obj Metric object header
* @return Builder by setting Metric object header
*/
Builder setMetricObjHeader(PcepObjectHeader obj);
/**
* Returns Metric value in Metric Object.
*
* @return Metric value
*/
int getMetricVal();
/**
* Sets Metric Value in Metric Object and returns its builder.
*
* @param value Metric Value
* @return Builder by setting Metric Value
*/
Builder setMetricVal(int value);
/**
* Returns Flags in Metric Object.
*
* @return Flags in Metric Object
*/
byte getYFlag();
/**
* Sets Flags in Metric Object and returns its builder.
*
* @param value Flags
* @return Builder by setting Flags
*/
Builder setYFlag(byte value);
/**
* Returns C flag in Metric Object.
*
* @return C flag in Metric Object
*/
boolean getCFlag();
/**
* Sets C flag in Metric Object and returns its builder.
*
* @param value C flag
* @return Builder by setting C flag
*/
Builder setCFlag(boolean value);
/**
* Returns B flag in Metric Object.
*
* @return B flag in Metric Object
*/
boolean getBFlag();
/**
* Sets B flag in Metric Object and returns its builder.
*
* @param value B flag
* @return Builder by setting B flag
*/
Builder setBFlag(boolean value);
/**
* Returns BType field in Metric Object.
*
* @return BType field in Metric Object
*/
byte getBType();
/**
* Sets B Type field in Metric Object and returns its builder.
*
* @param value B Type field
* @return Builder by setting B Type field
*/
Builder setBType(byte value);
/**
* Sets P flag in Metric object header and returns its builder.
*
* @param value boolean value to set P flag
* @return Builder by setting P flag
*/
Builder setPFlag(boolean value);
/**
* Sets I flag in Metric object header and returns its builder.
*
* @param value boolean value to set I flag
* @return Builder by setting I flag
*/
Builder setIFlag(boolean value);
}
}
|
