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

## org.apache.commons.lang.mutable
Interface Mutable

All Known Implementing Classes:
  MutableByte, MutableShort, MutableDouble, MutableInt, MutableFloat, MutableObject, MutableLong, MutableBoolean

public interface Mutable

Provides mutable access to a value.

`Mutable` is used as a generic interface to the implementations in this package.

A typical use case would be to enable a primitive or string to be passed to a method and allow that method to effectively change the value of the primitive/string. Another use case is to store a frequently changing primitive in a collection (for example a total in a map) without needing to create new Integer/Long wrapper objects.

Since:
  2.1
Version:
  $Id: Mutable.java 437554 2006-08-28 06:21:41Z bayard $
Author:
  Matthew Hawthorne

Method Summary
`Object` | `getValue()` Gets the value of this mutable.
`void` | `setValue(Object value)` Sets the value of this mutable.

Method Detail

### getValue

    public Object getValue()

  Gets the value of this mutable.
  Returns:
    the stored value

### setValue

    public void setValue(Object value)

  Sets the value of this mutable.
  Parameters:
    `value` - the value to store
  Throws:
    `NullPointerException` - if the object is null and null is invalid
    `ClassCastException` - if the type is invalid

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

Copyright © 2001-2005 - Apache Software Foundation