Class PiHeader

  • All Implemented Interfaces:
    PiData

    @Beta
    public final class PiHeader
    extends java.lang.Object
    implements PiData
    Instance of a PiHeader in a protocol-independent pipeline.
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.onosproject.net.pi.model.PiData

        PiData.Type
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<org.onlab.util.ImmutableByteSequence> bitStrings()
      Return the header bit strings.
      boolean equals​(java.lang.Object o)  
      int hashCode()  
      java.lang.Boolean isValid()
      Return whether the header is valid.
      static PiHeader of​(java.lang.Boolean isValid, java.util.List<org.onlab.util.ImmutableByteSequence> bitStrings)
      Returns a new protocol-independent header.
      java.lang.String toString()  
      PiData.Type type()
      Returns the type of this protocol-independent data.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • of

        public static PiHeader of​(java.lang.Boolean isValid,
                                  java.util.List<org.onlab.util.ImmutableByteSequence> bitStrings)
        Returns a new protocol-independent header.
        Parameters:
        isValid - whether the header is valid
        bitStrings - bitstrings
        Returns:
        header
      • isValid

        public java.lang.Boolean isValid()
        Return whether the header is valid.
        Returns:
        bool
      • bitStrings

        public java.util.List<org.onlab.util.ImmutableByteSequence> bitStrings()
        Return the header bit strings.
        Returns:
        the list of bit string
      • type

        public PiData.Type type()
        Description copied from interface: PiData
        Returns the type of this protocol-independent data.
        Specified by:
        type in interface PiData
        Returns:
        the type of this instance
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object