ScanLevel (OpenNMS 1.10.14 API)

java.lang.Object
- org.opennms.netmgt.config.vulnscand.ScanLevel

All Implemented Interfaces:

Serializable
```
public class ScanLevel
extends Object
implements Serializable
```
Class ScanLevel.

Version:

$Revision$ $Date$

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScanLevel()

Constructors
Constructor and Description
`ScanLevel()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRange(int index, Range vRange)`
`void`	`addRange(Range vRange)`
`void`	`addSpecific(int index, String vSpecific)`
`void`	`addSpecific(String vSpecific)`
`void`	`deleteLevel()`
`void`	`deleteSafeChecks()`
`Enumeration<Range>`	`enumerateRange()` Method enumerateRange.
`Enumeration<String>`	`enumerateSpecific()` Method enumerateSpecific.
`boolean`	`equals(Object obj)` Overrides the java.lang.Object.equals method.
`int`	`getLevel()` Returns the value of field 'level'.
`String`	`getPluginList()` Returns the value of field 'pluginList'.
`Range[]`	`getRange()` Method getRange.Returns the contents of the collection in an Array.
`Range`	`getRange(int index)` Method getRange.
`List<Range>`	`getRangeCollection()` Method getRangeCollection.Returns a reference to '_rangeList'.
`int`	`getRangeCount()` Method getRangeCount.
`boolean`	`getSafeChecks()` Returns the value of field 'safeChecks'.
`String[]`	`getSpecific()` Method getSpecific.Returns the contents of the collection in an Array.
`String`	`getSpecific(int index)` Method getSpecific.
`List<String>`	`getSpecificCollection()` Method getSpecificCollection.Returns a reference to '_specificList'.
`int`	`getSpecificCount()` Method getSpecificCount.
`int`	`hashCode()` Overrides the java.lang.Object.hashCode method.
`boolean`	`hasLevel()` Method hasLevel.
`boolean`	`hasSafeChecks()` Method hasSafeChecks.
`boolean`	`isSafeChecks()` Returns the value of field 'safeChecks'.
`boolean`	`isValid()` Method isValid.
`Iterator<Range>`	`iterateRange()` Method iterateRange.
`Iterator<String>`	`iterateSpecific()` Method iterateSpecific.
`void`	`marshal(ContentHandler handler)`
`void`	`marshal(Writer out)`
`void`	`removeAllRange()`
`void`	`removeAllSpecific()`
`boolean`	`removeRange(Range vRange)` Method removeRange.
`Range`	`removeRangeAt(int index)` Method removeRangeAt.
`boolean`	`removeSpecific(String vSpecific)` Method removeSpecific.
`String`	`removeSpecificAt(int index)` Method removeSpecificAt.
`void`	`setLevel(int level)` Sets the value of field 'level'.
`void`	`setPluginList(String pluginList)` Sets the value of field 'pluginList'.
`void`	`setRange(int index, Range vRange)`
`void`	`setRange(List<Range> vRangeList)` Sets the value of '_rangeList' by copying the given Vector.
`void`	`setRange(Range[] vRangeArray)`
`void`	`setRangeCollection(List<Range> rangeList)` Deprecated.
`void`	`setSafeChecks(boolean safeChecks)` Sets the value of field 'safeChecks'.
`void`	`setSpecific(int index, String vSpecific)`
`void`	`setSpecific(List<String> vSpecificList)` Sets the value of '_specificList' by copying the given Vector.
`void`	`setSpecific(String[] vSpecificArray)`
`void`	`setSpecificCollection(List<String> specificList)` Deprecated.
`static ScanLevel`	`unmarshal(Reader reader)` Method unmarshal.
`void`	`validate()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScanLevel
```
public ScanLevel()
```
- Method Detail
  - addRange
```
public void addRange(Range vRange)
              throws IndexOutOfBoundsException
```
    Parameters:
    vRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addRange
```
public void addRange(int index,
            Range vRange)
              throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSpecific
```
public void addSpecific(String vSpecific)
                 throws IndexOutOfBoundsException
```
    Parameters:
    vSpecific -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - addSpecific
```
public void addSpecific(int index,
               String vSpecific)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vSpecific -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - deleteLevel
```
public void deleteLevel()
```
  - deleteSafeChecks
```
public void deleteSafeChecks()
```
  - enumerateRange
```
public Enumeration<Range> enumerateRange()
```
    Method enumerateRange.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - enumerateSpecific
```
public Enumeration<String> enumerateSpecific()
```
    Method enumerateSpecific.
    
    Returns:
    an Enumeration over all possible elements of this collection
  - equals
```
public boolean equals(Object obj)
```
    Overrides the java.lang.Object.equals method.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj -
    
    Returns:
    true if the objects are equal.
  - getLevel
```
public int getLevel()
```
    Returns the value of field 'level'.
    
    Returns:
    the value of field 'Level'.
  - getPluginList
```
public String getPluginList()
```
    Returns the value of field 'pluginList'.
    
    Returns:
    the value of field 'PluginList'.
  - getRange
```
public Range getRange(int index)
               throws IndexOutOfBoundsException
```
    Method getRange.
    
    Parameters:
    index -
    
    Returns:
    the value of the org.opennms.netmgt.config.vulnscand.Range at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getRange
```
public Range[] getRange()
```
    Method getRange.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    this collection as an Array
  - getRangeCollection
```
public List<Range> getRangeCollection()
```
    Method getRangeCollection.Returns a reference to '_rangeList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getRangeCount
```
public int getRangeCount()
```
    Method getRangeCount.
    
    Returns:
    the size of this collection
  - getSafeChecks
```
public boolean getSafeChecks()
```
    Returns the value of field 'safeChecks'.
    
    Returns:
    the value of field 'SafeChecks'.
  - getSpecific
```
public String getSpecific(int index)
                   throws IndexOutOfBoundsException
```
    Method getSpecific.
    
    Parameters:
    index -
    
    Returns:
    the value of the java.lang.String at the given index
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - getSpecific
```
public String[] getSpecific()
```
    Method getSpecific.Returns the contents of the collection in an Array.
    Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
    
    Returns:
    this collection as an Array
  - getSpecificCollection
```
public List<String> getSpecificCollection()
```
    Method getSpecificCollection.Returns a reference to '_specificList'. No type checking is performed on any modifications to the Vector.
    
    Returns:
    a reference to the Vector backing this class
  - getSpecificCount
```
public int getSpecificCount()
```
    Method getSpecificCount.
    
    Returns:
    the size of this collection
  - hasLevel
```
public boolean hasLevel()
```
    Method hasLevel.
    
    Returns:
    true if at least one Level has been added
  - hasSafeChecks
```
public boolean hasSafeChecks()
```
    Method hasSafeChecks.
    
    Returns:
    true if at least one SafeChecks has been added
  - hashCode
```
public int hashCode()
```
    Overrides the java.lang.Object.hashCode method.
    The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value for the object.
  - isSafeChecks
```
public boolean isSafeChecks()
```
    Returns the value of field 'safeChecks'.
    
    Returns:
    the value of field 'SafeChecks'.
  - isValid
```
public boolean isValid()
```
    Method isValid.
    
    Returns:
    true if this object is valid according to the schema
  - iterateRange
```
public Iterator<Range> iterateRange()
```
    Method iterateRange.
    
    Returns:
    an Iterator over all possible elements in this collection
  - iterateSpecific
```
public Iterator<String> iterateSpecific()
```
    Method iterateSpecific.
    
    Returns:
    an Iterator over all possible elements in this collection
  - marshal
```
public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
```
    Parameters:
    out -
    
    Throws:
    
    org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
    
    org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
  - marshal
```
public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
```
    Parameters:
    handler -
    
    Throws:
    
    IOException - if an IOException occurs during marshaling
    
    org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
    
    org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
  - removeAllRange
```
public void removeAllRange()
```
  - removeAllSpecific
```
public void removeAllSpecific()
```
  - removeRange
```
public boolean removeRange(Range vRange)
```
    Method removeRange.
    
    Parameters:
    vRange -
    
    Returns:
    true if the object was removed from the collection.
  - removeRangeAt
```
public Range removeRangeAt(int index)
```
    Method removeRangeAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - removeSpecific
```
public boolean removeSpecific(String vSpecific)
```
    Method removeSpecific.
    
    Parameters:
    vSpecific -
    
    Returns:
    true if the object was removed from the collection.
  - removeSpecificAt
```
public String removeSpecificAt(int index)
```
    Method removeSpecificAt.
    
    Parameters:
    index -
    
    Returns:
    the element removed from the collection
  - setLevel
```
public void setLevel(int level)
```
    Sets the value of field 'level'.
    
    Parameters:
    level - the value of field 'level'.
  - setPluginList
```
public void setPluginList(String pluginList)
```
    Sets the value of field 'pluginList'.
    
    Parameters:
    pluginList - the value of field 'pluginList'.
  - setRange
```
public void setRange(int index,
            Range vRange)
              throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vRange -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setRange
```
public void setRange(Range[] vRangeArray)
```
    Parameters:
    vRangeArray -
  - setRange
```
public void setRange(List<Range> vRangeList)
```
    Sets the value of '_rangeList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vRangeList - the Vector to copy.
  - setRangeCollection
```
public void setRangeCollection(List<Range> rangeList)
```
    Deprecated.
    
    Sets the value of '_rangeList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    rangeList - the Vector to set.
  - setSafeChecks
```
public void setSafeChecks(boolean safeChecks)
```
    Sets the value of field 'safeChecks'.
    
    Parameters:
    safeChecks - the value of field 'safeChecks'.
  - setSpecific
```
public void setSpecific(int index,
               String vSpecific)
                 throws IndexOutOfBoundsException
```
    Parameters:
    index -
    vSpecific -
    
    Throws:
    
    IndexOutOfBoundsException - if the index given is outside the bounds of the collection
  - setSpecific
```
public void setSpecific(String[] vSpecificArray)
```
    Parameters:
    vSpecificArray -
  - setSpecific
```
public void setSpecific(List<String> vSpecificList)
```
    Sets the value of '_specificList' by copying the given Vector. All elements will be checked for type safety.
    
    Parameters:
    vSpecificList - the Vector to copy.
  - setSpecificCollection
```
public void setSpecificCollection(List<String> specificList)
```
    Deprecated.
    
    Sets the value of '_specificList' by setting it to the given Vector. No type checking is performed.
    
    Parameters:
    specificList - the Vector to set.
  - unmarshal
```
public static ScanLevel unmarshal(Reader reader)
                           throws org.exolab.castor.xml.MarshalException,
                                  org.exolab.castor.xml.ValidationException
```
    Method unmarshal.
    
    Parameters:
    reader -
    
    Returns:
    the unmarshaled org.opennms.netmgt.config.vulnscand.ScanLevel
    
    Throws:
    
    org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
    
    org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
  - validate
```
public void validate()
              throws org.exolab.castor.xml.ValidationException
```
    Throws:
    
    org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

Class ScanLevel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScanLevel

Method Detail

addRange

addRange

addSpecific

addSpecific

deleteLevel

deleteSafeChecks

enumerateRange

enumerateSpecific

equals

getLevel

getPluginList

getRange

getRange

getRangeCollection

getRangeCount

getSafeChecks

getSpecific

getSpecific

getSpecificCollection

getSpecificCount

hasLevel

hasSafeChecks

hashCode

isSafeChecks

isValid

iterateRange

iterateSpecific

marshal

marshal

removeAllRange

removeAllSpecific

removeRange

removeRangeAt

removeSpecific

removeSpecificAt

setLevel

setPluginList

setRange

setRange

setRange

setRangeCollection

setSafeChecks

setSpecific

setSpecific

setSpecific

setSpecificCollection

unmarshal

validate