Class BandwidthProfile.Builder

  • Enclosing class:
    BandwidthProfile

    public static final class BandwidthProfile.Builder
    extends java.lang.Object
    Builder of BandwidthProfile entities.
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • name

        public BandwidthProfile.Builder name​(java.lang.String name)
        Sets the name of this bandwidth profile builder.
        Parameters:
        name - the builder name to set
        Returns:
        this builder instance
      • cir

        public BandwidthProfile.Builder cir​(Bandwidth cir)
        Sets the committed information rate (CIR) of this builder.
        Parameters:
        cir - the builder CIR to set
        Returns:
        this builder instance
      • pir

        public BandwidthProfile.Builder pir​(Bandwidth pir)
        Sets the peak information rate (PIR) of this builder.
        Parameters:
        pir - the builder PIR to set
        Returns:
        this builder instance
      • cbs

        public BandwidthProfile.Builder cbs​(java.lang.Integer cbs)
        Sets the committed burst size (CBS) of this builder. The CBS is measured in bytes.
        Parameters:
        cbs - the builder CBS to set
        Returns:
        this builder instance
      • pbs

        public BandwidthProfile.Builder pbs​(java.lang.Integer pbs)
        Sets the peak burst size (PBS) of this builder. The PBS is measured in bytes.
        Parameters:
        pbs - the builder CBS to set
        Returns:
        this builder instance
      • ebs

        public BandwidthProfile.Builder ebs​(java.lang.Integer ebs)
        Sets the excess burst size (EBS) of this builder. The EBS is measured in bytes.
        Parameters:
        ebs - the builder EBS to set
        Returns:
        this builder instance
      • yellowAction

        public BandwidthProfile.Builder yellowAction​(BandwidthProfileAction yellowAction)
        Sets the yellow action of this builder.
        Parameters:
        yellowAction - the builder green action to set
        Returns:
        this builder instance
      • colorAware

        public BandwidthProfile.Builder colorAware​(boolean colorAware)
        Sets the color-aware mode of this builder.
        Parameters:
        colorAware - true if profile to be build is color-aware; false otherwise
        Returns:
        this builder instance
      • build

        public BandwidthProfile build()
        Builds a new BandwidthProfile instance. based on this builder's parameters
        Returns:
        a new BandwidthProfile instance