org.apache.directory.server.dhcp.options

Class OptionsField

java.lang.Object

org.apache.directory.server.dhcp.options.OptionsField

public class OptionsField
extends java.lang.Object

The Dynamic Host Configuration Protocol (DHCP) provides a framework for passing configuration information to hosts on a TCP/IP network. Configuration parameters and other control information are carried in tagged data items that are stored in the 'options' field of the DHCP message. The data items themselves are also called "options."

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map	options A map of option code (Integer)->DhcpOption.

Constructor Summary

Constructors

Constructor and Description
OptionsField()

Method Summary

Modifier and Type	Method and Description
void	add(DhcpOption option)
void	clear()
DhcpOption	get(java.lang.Class optionClass) Return the (first) DHCP option matching a given option class or null of the option isn't set.
DhcpOption	get(int tag) Return the (first) DHCP option matching a given tag or null of the option isn't set.
boolean	isEmpty()
java.util.Iterator	iterator()
void	merge(OptionsField options) Merge the options from the given options field into my options.
void	remove(java.lang.Class c) Remove instances of the given option class.
void	remove(int tag) Remove options matching the given tag

Methods inherited from class java.lang.Object

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

Field Detail

options

private java.util.Map options

A map of option code (Integer)->DhcpOption. FIXME: use IntHashtable from commons collections

Constructor Detail

OptionsField

public OptionsField()

Method Detail

add

public void add(DhcpOption option)

isEmpty

public boolean isEmpty()

iterator

public java.util.Iterator iterator()

get

public DhcpOption get(java.lang.Class optionClass)

Return the (first) DHCP option matching a given option class or null of the option isn't set.

Parameters:

optionClass -

get

public DhcpOption get(int tag)

Return the (first) DHCP option matching a given tag or null of the option isn't set.

Parameters:

tag -

merge

public void merge(OptionsField options)

Merge the options from the given options field into my options. Existing options are replaced by the ones from the supplied options field.

Parameters:

options -

remove

public void remove(java.lang.Class c)

Remove instances of the given option class.

Parameters:

c -

remove

public void remove(int tag)

Remove options matching the given tag

Parameters:

tag -

clear

public void clear()

See Also:

Map.clear()