Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.shrinkwrap.descriptor.api.javaee5
Interface ListenerType<T>

All Superinterfaces:
  org.jboss.shrinkwrap.descriptor.api.Child<T>

All Known Implementing Classes:
  ListenerTypeImpl

    public interface ListenerType<T>

extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the `listenerType` xsd type

Original Documentation:

The listenerType indicates the deployment properties for a web
application listener bean.

Since:
  Generation date :2011-07-19T22:54:35.59+02:00
Author:
  Ralf Battenfeld

Method Summary
`java.util.List<java.lang.String>` | `getDescriptionList()` Returns all `description` elements
`java.util.List<java.lang.String>` | `getDisplayNameList()` Returns all `display-name` elements
`java.util.List<IconType<ListenerType<T>>>` | `getIconList()` Returns all `icon` elements
`java.lang.String` | `getListenerClass()` Returns the `listener-class` element
`IconType<ListenerType<T>>` | `icon()` Returns the `icon` element
`ListenerType<T>` | `removeAllDescription()` Removes the `description` element
`ListenerType<T>` | `removeAllDisplayName()` Removes the `display-name` element
`ListenerType<T>` | `removeAllIcon()` Removes all `icon` elements
`ListenerType<T>` | `removeListenerClass()` Removes the `listener-class` element
`ListenerType<T>` | `setDescription(java.lang.String description)` Creates a new `description` element
`ListenerType<T>` | `setDescriptionList(java.lang.String... values)` Creates for all String objects representing `description` elements, a new `description` element
`ListenerType<T>` | `setDisplayName(java.lang.String displayName)` Creates a new `display-name` element
`ListenerType<T>` | `setDisplayNameList(java.lang.String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`ListenerType<T>` | `setListenerClass(java.lang.String listenerClass)` If not already created, a new `listener-class` element with the given value will be created.

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
`up`

Method Detail

### setDescription

    ListenerType<T> setDescription(java.lang.String description)

  Creates a new `description` element

  Returns:
    the current instance of `ListenerType`

### setDescriptionList

    ListenerType<T> setDescriptionList(java.lang.String... values)

  Creates for all String objects representing `description` elements, a new `description` element

  Parameters:
    `list` - of `description` objects
  Returns:
    the current instance of `ListenerType`

### removeAllDescription

    ListenerType<T> removeAllDescription()

  Removes the `description` element

  Returns:
    the current instance of `ListenerType`

### getDescriptionList

    java.util.List<java.lang.String> getDescriptionList()

  Returns all `description` elements

  Returns:
    list of `description`

### setDisplayName

    ListenerType<T> setDisplayName(java.lang.String displayName)

  Creates a new `display-name` element

  Returns:
    the current instance of `ListenerType`

### setDisplayNameList

    ListenerType<T> setDisplayNameList(java.lang.String... values)

  Creates for all String objects representing `display-name` elements, a new `display-name` element

  Parameters:
    `list` - of `display-name` objects
  Returns:
    the current instance of `ListenerType`

### removeAllDisplayName

    ListenerType<T> removeAllDisplayName()

  Removes the `display-name` element

  Returns:
    the current instance of `ListenerType`

### getDisplayNameList

    java.util.List<java.lang.String> getDisplayNameList()

  Returns all `display-name` elements

  Returns:
    list of `display-name`

### removeAllIcon

    ListenerType<T> removeAllIcon()

  Removes all `icon` elements

  Returns:
    the current instance of `ListenerType`

### icon

    IconType<ListenerType<T>> icon()

  Returns the `icon` element

  Returns:
    the node defined for the element `icon`

### getIconList

    java.util.List<IconType<ListenerType<T>>> getIconList()

  Returns all `icon` elements

  Returns:
    list of `icon`

### setListenerClass

    ListenerType<T> setListenerClass(java.lang.String listenerClass)

  If not already created, a new `listener-class` element with the given value will be created. Otherwise, the existing `listener-class` element will be updated with the given value.

  Returns:
    the current instance of `ListenerType`

### removeListenerClass

    ListenerType<T> removeListenerClass()

  Removes the `listener-class` element

  Returns:
    the current instance of `ListenerType`

### getListenerClass

    java.lang.String getListenerClass()

  Returns the `listener-class` element

  Returns:
    the node defined for the element `listener-class`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD