DumpEntity (bw-carddav-server 4.0.10 API)

java.lang.Object
- org.bedework.carddav.server.dirHandlers.db.DumpEntity<T>

Type Parameters:

T -

All Implemented Interfaces:

org.bedework.util.logging.Logged

Direct Known Subclasses:

UnversionedDbentity
```
public class DumpEntity<T>
extends Object
implements org.bedework.util.logging.Logged
```
An entity which can be dumped..

Version:

1.0

Author:

Mike Douglass

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DumpEntity.DumpType
We're dumping the entire object

Constructor Summary

Constructors
Constructor Description

DumpEntity()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`dump(org.bedework.util.xml.XmlEmit xml, DumpEntity.DumpType dtype)`	Dump this entity as xml.
`void`	`dump(org.bedework.util.xml.XmlEmit xml, DumpEntity.DumpType dtype, boolean fromCollection)`	Dump this entity as xml.
`org.bedework.util.logging.BwLogger`	`getLogger()`
`boolean`	`hasDumpValue()`	Override this if we want to optionally suppress the dump based on some attributes.

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

Methods inherited from interface org.bedework.util.logging.Logged
audit, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, setLogLevel, trace, trace, warn

- Constructor Detail
  - DumpEntity
```
public DumpEntity()
```
- Method Detail
  - hasDumpValue
```
public boolean hasDumpValue()
                     throws org.bedework.webdav.servlet.shared.WebdavException
```
    Override this if we want to optionally suppress the dump based on some attributes. This allows us to skip empty objects which occassionally turn up.
    
    Returns:
    
    boolean true to continue with dump.
    
    Throws:
    
    org.bedework.webdav.servlet.shared.WebdavException
  - dump
```
public void dump(org.bedework.util.xml.XmlEmit xml,
                 DumpEntity.DumpType dtype)
          throws org.bedework.webdav.servlet.shared.WebdavException
```
    Dump this entity as xml.
    
    Parameters:
    
    xml -
    
    dtype -
    
    Throws:
    
    org.bedework.webdav.servlet.shared.WebdavException
  - dump
```
public void dump(org.bedework.util.xml.XmlEmit xml,
                 DumpEntity.DumpType dtype,
                 boolean fromCollection)
          throws org.bedework.webdav.servlet.shared.WebdavException
```
    Dump this entity as xml.
    
    Parameters:
    
    xml -
    
    dtype -
    
    fromCollection - true if the value is a member of a collection
    
    Throws:
    
    org.bedework.webdav.servlet.shared.WebdavException
  - getLogger
```
public org.bedework.util.logging.BwLogger getLogger()
```
    Specified by:
    
    getLogger in interface org.bedework.util.logging.Logged