Package org.bedework.calfacade.base

Class DumpEntity<T>

java.lang.Object
org.bedework.calfacade.base.DumpEntity<T>
Type Parameters:
T -
All Implemented Interfaces:
org.bedework.util.logging.Logged
Direct Known Subclasses:
BwAuthUserPrefs, BwDateTime, BwGeo, BwOrganizer, BwRelatedTo, BwUnversionedDbentity, CollectionPref
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 enum 
    DumpEntity.DumpType
    We're dumping the entire object

  • Constructor Summary

    Constructors
    Constructor
    Description
    DumpEntity()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dump(File f)
    Dump the entire entity into the given file.
    void
    dump(org.bedework.util.xml.XmlEmit xml)
    Dump the entire entity.
    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, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn

  • Constructor Details

    • DumpEntity

      public DumpEntity()

  • Method Details

    • hasDumpValue

      public boolean hasDumpValue()
      Override this if we want to optionally suppress the dump based on some attributes. This allows us to skip empty objects which occasionally turn up.
      Returns:
      boolean true to continue with dump.

    • dump

      public void dump(File f)
      Dump the entire entity into the given file.
      Parameters:
      f - - the file

    • dump

      public void dump(org.bedework.util.xml.XmlEmit xml)
      Dump the entire entity.
      Parameters:
      xml - emitter

    • getLogger

      public org.bedework.util.logging.BwLogger getLogger()
      Specified by:
      getLogger in interface org.bedework.util.logging.Logged