Class DefaultDeviceInterfaceDescription

    • Constructor Detail

      • DefaultDeviceInterfaceDescription

        public DefaultDeviceInterfaceDescription​(java.lang.String name,
                                                 DeviceInterfaceDescription.Mode mode,
                                                 java.util.List<VlanId> vlans,
                                                 boolean isRateLimited,
                                                 short rateLimit)
        Device interface description object constructor.
        Parameters:
        name - the name of the interface
        mode - the operation mode of the interface
        vlans - the vlan-id of the interface (none, one or multiple can be specified based on if mode is normal, access or trunk).
        isRateLimited - bandwidth limit application indication
        rateLimit - percentage of bandwidth limit
    • Method Detail

      • name

        public java.lang.String name()
        Returns the name of the interface.
        Specified by:
        name in interface DeviceInterfaceDescription
        Returns:
        name of the interface
      • vlans

        public java.util.List<VlanId> vlans()
        Returns the VLAN-IDs configured for the interface. No VLAN-ID should be returned for NORMAL mode, 1 VLAN-ID for access mode and 1 or more VLAN-IDs for trunking mode.
        Specified by:
        vlans in interface DeviceInterfaceDescription
        Returns:
        VLAN-ID(s) configured for the interface.
      • isRateLimited

        public boolean isRateLimited()
        Indicates whether a rate limit has been set on the interface.
        Specified by:
        isRateLimited in interface DeviceInterfaceDescription
        Returns:
        indication whether interface is rate limited or not
      • rateLimit

        public short rateLimit()
        Returns the rate limit set on the interface bandwidth.
        Specified by:
        rateLimit in interface DeviceInterfaceDescription
        Returns:
        the rate limit set on the interface bandwidth
      • equals

        public boolean equals​(java.lang.Object other)
        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