Phaneendra Manda | 1c0061d | 2015-08-06 12:29:38 +0530 | [diff] [blame] | 1 | /*
|
| 2 | * Copyright 2015 Open Networking Laboratory
|
| 3 | *
|
| 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
| 5 | * you may not use this file except in compliance with the License.
|
| 6 | * You may obtain a copy of the License at
|
| 7 | *
|
| 8 | * http://www.apache.org/licenses/LICENSE-2.0
|
| 9 | *
|
| 10 | * Unless required by applicable law or agreed to in writing, software
|
| 11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 13 | * See the License for the specific language governing permissions and
|
| 14 | * limitations under the License.
|
| 15 | */
|
| 16 | package org.onosproject.pcepio.protocol;
|
| 17 |
|
| 18 | import org.jboss.netty.buffer.ChannelBuffer;
|
| 19 | import org.onosproject.pcepio.exceptions.PcepParseException;
|
| 20 | import org.onosproject.pcepio.types.PcepObjectHeader;
|
| 21 |
|
| 22 | /**
|
| 23 | * Abstraction of an entity providing PCEP INTER Layer Object.
|
| 24 | */
|
| 25 | public interface PcepInterLayerObject {
|
| 26 |
|
| 27 | /**
|
| 28 | * Returns N Flag in INTER Layer Object.
|
| 29 | *
|
| 30 | * @return N Flag in INTER Layer Object
|
| 31 | */
|
| 32 | boolean getbNFlag();
|
| 33 |
|
| 34 | /**
|
| 35 | * Sets N Flag in INTER Layer Object with specified value.
|
| 36 | *
|
| 37 | * @param value N Flag
|
| 38 | */
|
| 39 | void setbNFlag(boolean value);
|
| 40 |
|
| 41 | /**
|
| 42 | * Returns I Flag in INTER Layer Object.
|
| 43 | *
|
| 44 | * @return I Flag in INTER Layer Object
|
| 45 | */
|
| 46 | boolean getbIFlag();
|
| 47 |
|
| 48 | /**
|
| 49 | * Sets I Flag in INTER Layer Object with specified value.
|
| 50 | *
|
| 51 | * @param value I Flag
|
| 52 | */
|
| 53 | void setbIFlag(boolean value);
|
| 54 |
|
| 55 | /**
|
| 56 | * Prints attributes of INTER Layer object.
|
| 57 | */
|
| 58 | void print();
|
| 59 |
|
| 60 | /**
|
| 61 | * Writes the INTER Layer Object into channel buffer.
|
| 62 | *
|
| 63 | * @param bb channel buffer
|
| 64 | * @return Returns the writerIndex of this buffer
|
| 65 | * @throws PcepParseException while writing Inter Layer Object.
|
| 66 | */
|
| 67 | int write(ChannelBuffer bb) throws PcepParseException;
|
| 68 |
|
| 69 | /**
|
| 70 | * Builder interface with get and set functions to build INTER Layer object.
|
| 71 | */
|
| 72 | public interface Builder {
|
| 73 |
|
| 74 | /**
|
| 75 | * Builds INTER Layer object.
|
| 76 | *
|
| 77 | * @return INTER Layer object
|
| 78 | */
|
| 79 | PcepInterLayerObject build();
|
| 80 |
|
| 81 | /**
|
| 82 | * Returns INTER Layer object header.
|
| 83 | *
|
| 84 | * @return INTER Layer object header
|
| 85 | */
|
| 86 | PcepObjectHeader getInterLayerObjHeader();
|
| 87 |
|
| 88 | /**
|
| 89 | * Sets INTER Layer object header and returns its builder.
|
| 90 | *
|
| 91 | * @param obj INTER Layer object header
|
| 92 | * @return Builder by setting INTER Layer object header
|
| 93 | */
|
| 94 | Builder setInterLayerObjHeader(PcepObjectHeader obj);
|
| 95 |
|
| 96 | /**
|
| 97 | * Returns N Flag in INTER Layer Object.
|
| 98 | *
|
| 99 | * @return N Flag in INTER Layer Object
|
| 100 | */
|
| 101 | boolean getbNFlag();
|
| 102 |
|
| 103 | /**
|
| 104 | * Sets N flag and return its builder.
|
| 105 | *
|
| 106 | * @param value N flag
|
| 107 | * @return Builder by setting N flag
|
| 108 | */
|
| 109 | Builder setbNFlag(boolean value);
|
| 110 |
|
| 111 | /**
|
| 112 | * Returns I Flag in INTER Layer Object.
|
| 113 | *
|
| 114 | * @return I Flag in INTER Layer Object
|
| 115 | */
|
| 116 | boolean getbIFlag();
|
| 117 |
|
| 118 | /**
|
| 119 | * Sets I flag and return its builder.
|
| 120 | *
|
| 121 | * @param value I flag
|
| 122 | * @return Builder by setting N flag
|
| 123 | */
|
| 124 | Builder setbIFlag(boolean value);
|
| 125 |
|
| 126 | /**
|
| 127 | * Sets P flag in INTER Layer object header and returns its builder.
|
| 128 | *
|
| 129 | * @param value boolean value to set P flag
|
| 130 | * @return Builder by setting P flag
|
| 131 | */
|
| 132 | Builder setPFlag(boolean value);
|
| 133 |
|
| 134 | /**
|
| 135 | * Sets I flag in INTER Layer object header and returns its builder.
|
| 136 | *
|
| 137 | * @param value boolean value to set I flag
|
| 138 | * @return Builder by setting I flag
|
| 139 | */
|
| 140 | Builder setIFlag(boolean value);
|
| 141 | }
|
| 142 | }
|