org.opendaylight.vtn.manager.internal.vnode.xml

Class XmlVInterface

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.xml.XmlVNode

org.opendaylight.vtn.manager.internal.vnode.xml.XmlVInterface

public final class XmlVInterface
extends XmlVNode

XmlVInterface provides XML binding to the data model for virtual interface.

Constructor Summary

Constructors

Constructor and Description
XmlVInterface(VtnMappableVinterface vif) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determine whether the given object is identical to this object.
FlowFilterList	getInputFilters() Return a list of input flow filters.
FlowFilterList	getOutputFilters() Return a list of output flow filters.
VTNPortMapConfig	getPortMap() Return a port mapping configuration if present.
int	hashCode() Return the hash code of this object.
static List<XmlVInterface>	toList(List<Vinterface> list) Convert the given virtual interface list into a list of XmlVInterface instances.
VinterfaceBuilder	toVinterfaceBuilder(XmlLogger xlogger, VInterfaceIdentifier<?> ifId) Convert this instance into a VinterfaceBuilder instance.

Methods inherited from class org.opendaylight.vtn.manager.internal.vnode.xml.XmlVNode

getDescription, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlVInterface

public XmlVInterface(VtnMappableVinterface vif)
              throws RpcException

Construct a new instance.

Parameters:

vif - A VtnMappableVinterface instance.

Throws:

RpcException - The given instance is invalid.

Method Detail

toList

public static List<XmlVInterface> toList(List<Vinterface> list)
                                  throws RpcException

Convert the given virtual interface list into a list of XmlVInterface instances.

Parameters:

list - A list of Vinterface instance.

Returns:

A list of XmlVInterface instance if the given list contains at least one virtual interface. null otherwise.

Throws:

RpcException - The given list contains instance instance.

getPortMap

public VTNPortMapConfig getPortMap()

Return a port mapping configuration if present.

Returns:

A VTNPortMapConfig instance if port mapping is configured in this virtual interface. Otherwise null.

getInputFilters

public FlowFilterList getInputFilters()

Return a list of input flow filters.

Returns:

A FlowFilterList instance or null.

getOutputFilters

public FlowFilterList getOutputFilters()

Return a list of output flow filters.

Returns:

A FlowFilterList instance or null.

toVinterfaceBuilder

public VinterfaceBuilder toVinterfaceBuilder(XmlLogger xlogger,
                                             VInterfaceIdentifier<?> ifId)
                                      throws RpcException

Convert this instance into a VinterfaceBuilder instance.

Note that returned instance contains only configuration. Runtime status needs to be resumed by the caller.

Parameters:

xlogger - A XmlLogger instance.

ifId - A VInterfaceIdentifier instance which specifies the virtual interface.

Returns:

A VinterfaceBuilder instance.

Throws:

RpcException - Failed to convert this instance.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class XmlVNode

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class XmlVNode

Returns:

The hash code.