mirrors/onos
1
0
Fork 0
mirror of https://github.com/opennetworkinglab/onos.git synced 2025-10-18 19:01:06 +02:00
Code Issues Projects Releases Wiki Activity

Correct javadoc

Browse Source 
Change-Id: Idf2b88f697f7077a57f7162e0a790c4a4872ae21
This commit is contained in:
hwchiu 2019-07-10 23:28:32 -07:00 committed by Charles Chan
parent 124d6a121b
commit effadedbe9
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
core/api/src/main/java/org/onosproject/net/flow/TrafficTreatment.java
View File

@ -43,6 +43,7 @@ public interface TrafficTreatment {
/** /**
* Returns the list of treatment instructions that will be applied * Returns the list of treatment instructions that will be applied
* further down the pipeline. * further down the pipeline.
*
* @return list of treatment instructions * @return list of treatment instructions
*/ */
List<Instruction> deferred(); List<Instruction> deferred();
@ -50,6 +51,7 @@ public interface TrafficTreatment {
/** /**
* Returns the list of treatment instructions that will be applied * Returns the list of treatment instructions that will be applied
* immediately. * immediately.
*
* @return list of treatment instructions * @return list of treatment instructions
*/ */
List<Instruction> immediate(); List<Instruction> immediate();
@ -64,6 +66,7 @@ public interface TrafficTreatment {
/** /**
* Returns the next table in the pipeline. * Returns the next table in the pipeline.
*
* @return a table transition; may be null. * @return a table transition; may be null.
*/ */
Instructions.TableTypeTransition tableTransition(); Instructions.TableTypeTransition tableTransition();
@ -71,6 +74,7 @@ public interface TrafficTreatment {
/** /**
* Whether the deferred treatment instructions will be cleared * Whether the deferred treatment instructions will be cleared
* by the device. * by the device.
*
* @return a boolean * @return a boolean
*/ */
boolean clearedDeferred(); boolean clearedDeferred();
@ -84,6 +88,7 @@ public interface TrafficTreatment {
/** /**
* Returns the stat trigger instruction if there is one. * Returns the stat trigger instruction if there is one.
*
* @return a stat trigger instruction; may be null. * @return a stat trigger instruction; may be null.
*/ */
Instructions.StatTriggerInstruction statTrigger(); Instructions.StatTriggerInstruction statTrigger();
@ -316,13 +321,15 @@ public interface TrafficTreatment {
Builder pushVlan(EthType ethType); Builder pushVlan(EthType ethType);
/** /**
* Any instructions preceded by this method call will be deferred. * Any instructions followed by this method call will be deferred.
*
* @return a treatment builder * @return a treatment builder
*/ */
Builder deferred(); Builder deferred();
/** /**
* Any instructions preceded by this method call will be immediate. * Any instructions followed by this method call will be immediate.
*
* @return a treatment builder * @return a treatment builder
*/ */
Builder immediate(); Builder immediate();
@ -330,12 +337,14 @@ public interface TrafficTreatment {
/** /**
* Instructs the device to clear the deferred instructions set. * Instructs the device to clear the deferred instructions set.
*
* @return a treatment builder * @return a treatment builder
*/ */
Builder wipeDeferred(); Builder wipeDeferred();
/** /**
* the instruction to clear not wipe the deferred instructions set. * the instruction to clear not wipe the deferred instructions set.
*
* @return a treatment builder * @return a treatment builder
*/ */
Builder notWipeDeferred(); Builder notWipeDeferred();