gerrit.opnfv Code Review - onosfw.git/blob

   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
  17 package org.onosproject.pcepio.protocol;
  18
  19 import org.jboss.netty.buffer.ChannelBuffer;
  20 import org.onosproject.pcepio.exceptions.PcepParseException;
  21
  22 /**
  23  * Abstraction of an entity providing PCEP Label Range Reservation Message.
  24  */
  25 public interface PcepLabelRangeResvMsg extends PcepObject, PcepMessage {
  26
  27     @Override
  28     PcepVersion getVersion();
  29
  30     @Override
  31     PcepType getType();
  32
  33     /**
  34      * Returns LabelRange field in Label Range Reservation message.
  35      *
  36      * @return LabelRange field
  37      */
  38     PcepLabelRange getLabelRange();
  39
  40     /**
  41      * Sets LabelRange field in Label Range Reservation message with specified value.
  42      *
  43      * @param lR label range object
  44      */
  45     void setLabelRange(PcepLabelRange lR);
  46
  47     @Override
  48     void writeTo(ChannelBuffer channelBuffer) throws PcepParseException;
  49
  50     /**
  51      * Builder interface with get and set functions to build Label Range Reservation message.
  52      */
  53     interface Builder extends PcepMessage.Builder {
  54
  55         @Override
  56         PcepLabelRangeResvMsg build();
  57
  58         @Override
  59         PcepVersion getVersion();
  60
  61         @Override
  62         PcepType getType();
  63
  64         /**
  65          * Returns LabelRange field in Label Range Reservation message.
  66          *
  67          * @return LabelRange object
  68          */
  69         PcepLabelRange getLabelRange();
  70
  71         /**
  72          * Sets LabelRange field and returns its Builder.
  73          *
  74          * @param lR label range object
  75          * @return builder by setting LabelRange field
  76          */
  77         Builder setLabelRange(PcepLabelRange lR);
  78     }
  79 }