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.ejbjar31
Interface AccessTimeoutType<T>

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

All Known Implementing Classes:
  AccessTimeoutTypeImpl

    public interface AccessTimeoutType<T>

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

This interface defines the contract for the `access-timeoutType` xsd type

Original Documentation:

The access-timeoutType represents the maximum amount of
time (in a given time unit) that the container should wait for
a concurrency lock before throwing a timeout exception to the
client.
A timeout value of 0 means concurrent access is not permitted.
A timeout value of -1 means wait indefinitely to acquire a lock.

Since:
  Generation date :2011-07-19T22:55:02.759+02:00
Author:
  Ralf Battenfeld

Method Summary
`java.lang.Integer` | `getTimeout()` Returns the `timeout` element
`TimeUnitTypeType` | `getUnit()` Returns the `unit` element
`java.lang.String` | `getUnitAsString()` Returns the `unit` element
`AccessTimeoutType<T>` | `removeTimeout()` Removes the `timeout` element
`AccessTimeoutType<T>` | `setTimeout(java.lang.Integer timeout)` If not already created, a new `timeout` element with the given value will be created.
`AccessTimeoutType<T>` | `setUnit(java.lang.String unit)` If not already created, a new `unit` element with the given value will be created.
`AccessTimeoutType<T>` | `setUnit(TimeUnitTypeType unit)` If not already created, a new `unit` element with the given value will be created.

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

Method Detail

### setTimeout

    AccessTimeoutType<T> setTimeout(java.lang.Integer timeout)

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

  Returns:
    the current instance of `AccessTimeoutType`

### removeTimeout

    AccessTimeoutType<T> removeTimeout()

  Removes the `timeout` element

  Returns:
    the current instance of `AccessTimeoutType`

### getTimeout

    java.lang.Integer getTimeout()

  Returns the `timeout` element

  Returns:
    the node defined for the element `timeout`

### setUnit

    AccessTimeoutType<T> setUnit(TimeUnitTypeType unit)

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

  Returns:
    the current instance of `AccessTimeoutType`

### setUnit

    AccessTimeoutType<T> setUnit(java.lang.String unit)

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

  Returns:
    the current instance of `AccessTimeoutType`

### getUnit

    TimeUnitTypeType getUnit()

  Returns the `unit` element

  Returns:
    the node defined for the element `unit`

### getUnitAsString

    java.lang.String getUnitAsString()

  Returns the `unit` element

  Returns:
    the node defined for the element `unit`

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