com.opensymphony.xwork2.util

## Class ValueStack.LegacyAdapter

- java.lang.Object
- - com.opensymphony.xwork2.util.ValueStack.LegacyAdapter

- All Implemented Interfaces:
    ValueStack
  Enclosing interface:
    ValueStack

      public static class ValueStack.LegacyAdapter
      extends Object
      implements ValueStack

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface com.opensymphony.xwork2.util.ValueStack

      `ValueStack.LegacyAdapter`

  - ### Field Summary

    - ### Fields inherited from interface org.apache.struts2.util.ValueStack

      `REPORT_ERRORS_ON_NO_PROP, VALUE_STACK`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `findString(String expr)`
    `String` | `findString(String expr, boolean throwExceptionOnFailure)`
    `Object` | `findValue(String expr)` Find a value by evaluating the given expression against the stack in the default search order.
    `Object` | `findValue(String expr, boolean throwExceptionOnFailure)`
    `Object` | `findValue(String expr, Class asType)` Find a value by evaluating the given expression against the stack in the default search order.
    `Object` | `findValue(String expr, Class asType, boolean throwExceptionOnFailure)`
    `ActionContext` | `getActionContext()`
    `Map<String,Object>` | `getContext()` Gets the context for this value stack.
    `Map<Object,Object>` | `getExprOverrides()` Gets the override map if anyone exists.
    `CompoundRoot` | `getRoot()` Get the CompoundRoot which holds the objects pushed onto the stack
    `Object` | `peek()` Get the object on the top of the stack without changing the stack.
    `Object` | `pop()` Get the object on the top of the stack and remove it from the stack.
    `void` | `push(Object o)` Put this object onto the top of the stack
    `void` | `set(String key, Object o)` Sets an object on the stack with the given key so it is retrievable by `ValueStack.findValue(String)`, `ValueStack.findValue(String, Class)`
    `void` | `setDefaultType(Class defaultType)` Sets the default type to convert to if no type is provided when getting a value.
    `void` | `setExprOverrides(Map<Object,Object> overrides)` Set a override map containing `key -> values` that takes precedent when doing find operations on the ValueStack.
    `void` | `setParameter(String expr, Object value)` Attempts to set a property on a bean in the stack with the given expression using the default search order.
    `void` | `setValue(String expr, Object value)` Attempts to set a property on a bean in the stack with the given expression using the default search order.
    `void` | `setValue(String expr, Object value, boolean throwExceptionOnFailure)` Attempts to set a property on a bean in the stack with the given expression using the default search order.
    `int` | `size()` Get the number of objects in the stack

    - ### Methods inherited from class java.lang.Object

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

    - ### Methods inherited from interface com.opensymphony.xwork2.util.ValueStack

      `adapt`

- - ### Method Detail

    - #### getContext

          public Map<String,Object> getContext()

      Description copied from interface: `ValueStack`
      Gets the context for this value stack. The context holds all the information in the value stack and it's surroundings.
      Specified by:
        `getContext` in interface `ValueStack`
      Returns:
        the context.

    - #### getActionContext

          public ActionContext getActionContext()

      Specified by:
        `getActionContext` in interface `ValueStack`

    - #### setDefaultType

          public void setDefaultType(Class defaultType)

      Description copied from interface: `ValueStack`
      Sets the default type to convert to if no type is provided when getting a value.
      Specified by:
        `setDefaultType` in interface `ValueStack`
      Parameters:
        `defaultType` - the new default type

    - #### setExprOverrides

          public void setExprOverrides(Map<Object,Object> overrides)

      Description copied from interface: `ValueStack`
      Set a override map containing `key -> values` that takes precedent when doing find operations on the ValueStack.

      See the unit test for ValueStackTest for examples.

      Specified by:
        `setExprOverrides` in interface `ValueStack`
      Parameters:
        `overrides` - overrides map.

    - #### getExprOverrides

          public Map<Object,Object> getExprOverrides()

      Description copied from interface: `ValueStack`
      Gets the override map if anyone exists.
      Specified by:
        `getExprOverrides` in interface `ValueStack`
      Returns:
        the override map, `null` if not set.

    - #### getRoot

          public CompoundRoot getRoot()

      Description copied from interface: `ValueStack`
      Get the CompoundRoot which holds the objects pushed onto the stack
      Specified by:
        `getRoot` in interface `ValueStack`
      Returns:
        the root

    - #### setValue

          public void setValue(String expr,
                               Object value)

      Description copied from interface: `ValueStack`
      Attempts to set a property on a bean in the stack with the given expression using the default search order.
      Specified by:
        `setValue` in interface `ValueStack`
      Parameters:
        `expr` - the expression defining the path to the property to be set.
        `value` - the value to be set into the named property

    - #### setParameter

          public void setParameter(String expr,
                                   Object value)

      Description copied from interface: `ValueStack`
      Attempts to set a property on a bean in the stack with the given expression using the default search order. N.B.: unlike #setValue(String,Object) it doesn't allow eval expression.
      Specified by:
        `setParameter` in interface `ValueStack`
      Parameters:
        `expr` - the expression defining the path to the property to be set.
        `value` - the value to be set into the named property

    - #### setValue

          public void setValue(String expr,
                               Object value,
                               boolean throwExceptionOnFailure)

      Description copied from interface: `ValueStack`
      Attempts to set a property on a bean in the stack with the given expression using the default search order.
      Specified by:
        `setValue` in interface `ValueStack`
      Parameters:
        `expr` - the expression defining the path to the property to be set.
        `value` - the value to be set into the named property
        `throwExceptionOnFailure` - a flag to tell whether an exception should be thrown if there is no property with the given name.

    - #### findString

          public String findString(String expr)

      Specified by:
        `findString` in interface `ValueStack`

    - #### findString

          public String findString(String expr,
                                   boolean throwExceptionOnFailure)

      Specified by:
        `findString` in interface `ValueStack`

    - #### findValue

          public Object findValue(String expr)

      Description copied from interface: `ValueStack`
      Find a value by evaluating the given expression against the stack in the default search order.
      Specified by:
        `findValue` in interface `ValueStack`
      Parameters:
        `expr` - the expression giving the path of properties to navigate to find the property value to return
      Returns:
        the result of evaluating the expression

    - #### findValue

          public Object findValue(String expr,
                                  boolean throwExceptionOnFailure)

      Specified by:
        `findValue` in interface `ValueStack`

    - #### findValue

          public Object findValue(String expr,
                                  Class asType)

      Description copied from interface: `ValueStack`
      Find a value by evaluating the given expression against the stack in the default search order.
      Specified by:
        `findValue` in interface `ValueStack`
      Parameters:
        `expr` - the expression giving the path of properties to navigate to find the property value to return
        `asType` - the type to convert the return value to
      Returns:
        the result of evaluating the expression

    - #### findValue

          public Object findValue(String expr,
                                  Class asType,
                                  boolean throwExceptionOnFailure)

      Specified by:
        `findValue` in interface `ValueStack`

    - #### peek

          public Object peek()

      Description copied from interface: `ValueStack`
      Get the object on the top of the stack without changing the stack.
      Specified by:
        `peek` in interface `ValueStack`
      Returns:
        the object on the top.
      See Also:
        `CompoundRoot.peek()`

    - #### pop

          public Object pop()

      Description copied from interface: `ValueStack`
      Get the object on the top of the stack and remove it from the stack.
      Specified by:
        `pop` in interface `ValueStack`
      Returns:
        the object on the top of the stack
      See Also:
        `CompoundRoot.pop()`

    - #### push

          public void push(Object o)

      Description copied from interface: `ValueStack`
      Put this object onto the top of the stack
      Specified by:
        `push` in interface `ValueStack`
      Parameters:
        `o` - the object to be pushed onto the stack
      See Also:
        `CompoundRoot.push(Object)`

    - #### set

          public void set(String key,
                          Object o)

      Description copied from interface: `ValueStack`
      Sets an object on the stack with the given key so it is retrievable by `ValueStack.findValue(String)`, `ValueStack.findValue(String, Class)`
      Specified by:
        `set` in interface `ValueStack`
      Parameters:
        `key` - the key
        `o` - the object

    - #### size

          public int size()

      Description copied from interface: `ValueStack`
      Get the number of objects in the stack
      Specified by:
        `size` in interface `ValueStack`
      Returns:
        the number of objects in the stack

Copyright © 2000–2025 Apache Software Foundation. All rights reserved.