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.apache.struts2.util
Class StrutsUtil

    java.lang.Object
      org.apache.struts2.util.StrutsUtil

Direct Known Subclasses:
  VelocityStrutsUtil

    public class StrutsUtil

extends Object

Struts base utility class, for use in Velocity and Freemarker templates

Nested Class Summary
`(package private) static class` | `StrutsUtil.ResponseWrapper`
`(package private) static class` | `StrutsUtil.ServletOutputStreamWrapper`

Field Summary
`protected Map` | `classes`
`protected static Log` | `log`
`protected OgnlTool` | `ognl`
`protected HttpServletRequest` | `request`
`protected HttpServletResponse` | `response`
`protected ValueStack` | `stack`

Constructor Summary
`StrutsUtil(ValueStack stack, HttpServletRequest request, HttpServletResponse response)`

Method Summary
`Object` | `bean(Object aName)`
`String` | `buildUrl(String url)`
`Object` | `findString(String name)`
`Object` | `findValue(String expression, String className)`
`String` | `getContext()`
`String` | `getText(String text)`
`String` | `htmlEncode(Object obj)`
`String` | `include(Object aName)`
`String` | `include(Object aName, HttpServletRequest aRequest, HttpServletResponse aResponse)` Deprecated. the request and response are stored in this util class, please use include(string)
`boolean` | `isTrue(String expression)`
`List` | `makeSelectList(String selectedList, String list, String listKey, String listValue)` the selectedList objects are matched to the list.listValue listKey and listValue are optional, and if not provided, the list item is used
`int` | `toInt(long aLong)`
`long` | `toLong(int anInt)`
`long` | `toLong(String aLong)`
`String` | `toString(int anInt)`
`String` | `toString(long aLong)`
`String` | `urlEncode(String s)`

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

Field Detail

### log

    protected static final Log log

### request

    protected HttpServletRequest request

### response

    protected HttpServletResponse response

### classes

    protected Map classes

### ognl

    protected OgnlTool ognl

### stack

    protected ValueStack stack

Constructor Detail

### StrutsUtil

    public StrutsUtil(ValueStack stack,
                      HttpServletRequest request,
                      HttpServletResponse response)

Method Detail

### bean

    public Object bean(Object aName)
                throws Exception

  Throws:
    `Exception`

### isTrue

    public boolean isTrue(String expression)

### findString

    public Object findString(String name)

### include

    public String include(Object aName)
                   throws Exception

  Throws:
    `Exception`

### include

    public String include(Object aName,
                          HttpServletRequest aRequest,
                          HttpServletResponse aResponse)
                   throws Exception

  Deprecated. the request and response are stored in this util class, please use include(string)

  Throws:
    `Exception`

### urlEncode

    public String urlEncode(String s)

### buildUrl

    public String buildUrl(String url)

### findValue

    public Object findValue(String expression,
                            String className)
                     throws ClassNotFoundException

  Throws:
    `ClassNotFoundException`

### getText

    public String getText(String text)

### getContext

    public String getContext()

### makeSelectList

    public List makeSelectList(String selectedList,
                               String list,
                               String listKey,
                               String listValue)

  the selectedList objects are matched to the list.listValue

  listKey and listValue are optional, and if not provided, the list item is used

  Parameters:
    `selectedList` - the name of the action property that contains the list of selected items or single item if its not an array or list
    `list` - the name of the action property that contains the list of selectable items
    `listKey` - an ognl expression that is exaluated relative to the list item to use as the key of the ListEntry
    `listValue` - an ognl expression that is exaluated relative to the list item to use as the value of the ListEntry
  Returns:
    a List of ListEntry

### htmlEncode

    public String htmlEncode(Object obj)

### toInt

    public int toInt(long aLong)

### toLong

    public long toLong(int anInt)

### toLong

    public long toLong(String aLong)

### toString

    public String toString(long aLong)

### toString

    public String toString(int anInt)

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

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.