StoreAppender (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.catalina.storeconfig.StoreAppender

Direct Known Subclasses:

ConnectorStoreAppender, StoreContextAppender
```
public class StoreAppender
extends Object
```
StoreAppends generate really the xml tag elements

Constructor Summary

Constructors
Constructor and Description

StoreAppender()

Constructors
Constructor and Description
`StoreAppender()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`convertStr(String input)` Given a string, this method replaces all occurrences of '<', '>', '&', and '"'.
`Object`	`defaultInstance(Object bean)` generate default Instance
`protected boolean`	`isPersistable(Class<?> clazz)` Is the specified property type one for which we should generate a persistence attribute?
`boolean`	`isPrintValue(Object bean, Object bean2, String attrName, StoreDescription desc)` print this Attribute value or not
`protected void`	`printAttribute(PrintWriter writer, int indent, Object bean, StoreDescription desc, String attributeName, Object bean2, Object value)`
`void`	`printAttributes(PrintWriter writer, int indent, boolean include, Object bean, StoreDescription desc)` Store the relevant attributes of the specified JavaBean.
`void`	`printAttributes(PrintWriter writer, int indent, Object bean, StoreDescription desc)` Store the relevant attributes of the specified JavaBean, plus a `className` attribute defining the fully qualified Java class name of the bean.
`void`	`printCloseTag(PrintWriter aWriter, StoreDescription aDesc)` print the closing tag
`void`	`printIndent(PrintWriter aWriter, int indent)` Print some spaces
`void`	`printOpenTag(PrintWriter aWriter, int indent, Object bean, StoreDescription aDesc)` print only the open tag with all attributes
`void`	`printTag(PrintWriter aWriter, int indent, Object bean, StoreDescription aDesc)` Print tag with all attributes
`void`	`printTagArray(PrintWriter aWriter, String tag, int indent, String[] elements)` print a array of elements
`void`	`printTagContent(PrintWriter aWriter, String tag, String content)` print the value from tag as content
`void`	`printTagValueArray(PrintWriter aWriter, String tag, int indent, String[] elements)` print an array of values
`void`	`printValue(PrintWriter writer, int indent, String name, Object value)` print an attribute value

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

Constructor Detail
- StoreAppender
```
public StoreAppender()
```

Method Detail

printCloseTag

public void printCloseTag(PrintWriter aWriter,
                 StoreDescription aDesc)
                   throws Exception

print the closing tag

Parameters:: aWriter -; aDesc -
Throws:: Exception

printOpenTag

public void printOpenTag(PrintWriter aWriter,
                int indent,
                Object bean,
                StoreDescription aDesc)
                  throws Exception

print only the open tag with all attributes

Parameters:: aWriter -; indent -; bean -; aDesc -
Throws:: Exception

printTag

public void printTag(PrintWriter aWriter,
            int indent,
            Object bean,
            StoreDescription aDesc)
              throws Exception

Print tag with all attributes

Parameters:: aWriter -; indent -; bean -; aDesc -
Throws:: Exception

printTagContent

public void printTagContent(PrintWriter aWriter,
                   String tag,
                   String content)
                     throws Exception

print the value from tag as content

Parameters:: aWriter -; tag -; content -
Throws:: Exception

printTagValueArray

public void printTagValueArray(PrintWriter aWriter,
                      String tag,
                      int indent,
                      String[] elements)

print an array of values

Parameters:: aWriter -; tag -; indent -; elements -

printTagArray

public void printTagArray(PrintWriter aWriter,
                 String tag,
                 int indent,
                 String[] elements)
                   throws Exception

print a array of elements

Parameters:: aWriter -; tag -; indent -; elements -
Throws:: Exception

printIndent

public void printIndent(PrintWriter aWriter,
               int indent)

Print some spaces

Parameters:: aWriter -; indent - number of spaces

printAttributes
```
public void printAttributes(PrintWriter writer,
                   int indent,
                   Object bean,
                   StoreDescription desc)
                     throws Exception
```
Store the relevant attributes of the specified JavaBean, plus a className attribute defining the fully qualified Java class name of the bean.

Parameters:
writer - PrintWriter to which we are storing
bean - Bean whose properties are to be rendered as attributes,

Throws:

Exception - if an exception occurs while storing

printAttributes
```
public void printAttributes(PrintWriter writer,
                   int indent,
                   boolean include,
                   Object bean,
                   StoreDescription desc)
                     throws Exception
```
Store the relevant attributes of the specified JavaBean.

Parameters:
writer - PrintWriter to which we are storing
include - Should we include a className attribute?
bean - Bean whose properties are to be rendered as attributes,
desc - RegistryDescrpitor from this bean

Throws:

Exception - if an exception occurs while storing

printAttribute

protected void printAttribute(PrintWriter writer,
                  int indent,
                  Object bean,
                  StoreDescription desc,
                  String attributeName,
                  Object bean2,
                  Object value)

Parameters:: writer -; indent -; bean -; desc -; attributeName -; bean2 -; value -

isPrintValue

public boolean isPrintValue(Object bean,
                   Object bean2,
                   String attrName,
                   StoreDescription desc)

print this Attribute value or not

Parameters:: bean - orginal bean; bean2 - default bean; attrName - attribute name; desc - StoreDescription from bean
Returns:: True if it's a printing value

defaultInstance

public Object defaultInstance(Object bean)
                       throws InstantiationException,
                              IllegalAccessException

generate default Instance

Parameters:: bean -
Returns:: an object from same class as bean parameter
Throws:: InstantiationException; IllegalAccessException

printValue

public void printValue(PrintWriter writer,
              int indent,
              String name,
              Object value)

print an attribute value

Parameters:: writer -; name -; value -

convertStr
```
public String convertStr(String input)
```
Given a string, this method replaces all occurrences of '<', '>', '&', and '"'.

isPersistable
```
protected boolean isPersistable(Class<?> clazz)
```
Is the specified property type one for which we should generate a persistence attribute?

Parameters:
clazz - Java class to be tested

Class StoreAppender

Constructor Summary