diff --git a/core/api/src/main/java/org/onosproject/net/flow/TrafficTreatment.java b/core/api/src/main/java/org/onosproject/net/flow/TrafficTreatment.java index 154f8c603a..50c3018b1d 100644 --- a/core/api/src/main/java/org/onosproject/net/flow/TrafficTreatment.java +++ b/core/api/src/main/java/org/onosproject/net/flow/TrafficTreatment.java @@ -43,6 +43,7 @@ public interface TrafficTreatment { /** * Returns the list of treatment instructions that will be applied * further down the pipeline. + * * @return list of treatment instructions */ List deferred(); @@ -50,6 +51,7 @@ public interface TrafficTreatment { /** * Returns the list of treatment instructions that will be applied * immediately. + * * @return list of treatment instructions */ List immediate(); @@ -64,6 +66,7 @@ public interface TrafficTreatment { /** * Returns the next table in the pipeline. + * * @return a table transition; may be null. */ Instructions.TableTypeTransition tableTransition(); @@ -71,6 +74,7 @@ public interface TrafficTreatment { /** * Whether the deferred treatment instructions will be cleared * by the device. + * * @return a boolean */ boolean clearedDeferred(); @@ -84,6 +88,7 @@ public interface TrafficTreatment { /** * Returns the stat trigger instruction if there is one. + * * @return a stat trigger instruction; may be null. */ Instructions.StatTriggerInstruction statTrigger(); @@ -316,13 +321,15 @@ public interface TrafficTreatment { 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 */ 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 */ Builder immediate(); @@ -330,12 +337,14 @@ public interface TrafficTreatment { /** * Instructs the device to clear the deferred instructions set. + * * @return a treatment builder */ Builder wipeDeferred(); /** * the instruction to clear not wipe the deferred instructions set. + * * @return a treatment builder */ Builder notWipeDeferred();