org.bedework.caldav.util.DumpUtil Maven / Gradle / Ivy

Go to download
/* ********************************************************************
    Licensed to Jasig under one or more contributor license
    agreements. See the NOTICE file distributed with this work
    for additional information regarding copyright ownership.
    Jasig licenses this file to you under the Apache License,
    Version 2.0 (the "License"); you may not use this file
    except in compliance with the License. You may obtain a
    copy of the License at:

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on
    an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.
*/
package org.bedework.caldav.util;

import org.bedework.util.logging.BwLogger;

import ietf.params.xml.ns.caldav.CalendarDataType;
import ietf.params.xml.ns.caldav.CompFilterType;
import ietf.params.xml.ns.caldav.CompType;
import ietf.params.xml.ns.caldav.FilterType;
import ietf.params.xml.ns.caldav.ParamFilterType;
import ietf.params.xml.ns.caldav.PropFilterType;
import ietf.params.xml.ns.caldav.PropType;
import ietf.params.xml.ns.caldav.TextMatchType;
import ietf.params.xml.ns.caldav.UTCTimeRangeType;

/** Various debug dump methods
 *
 *   @author Mike Douglass   douglm  bedework.edu
 */
public class DumpUtil {
  private static BwLogger logger =
          new BwLogger().setLoggedClass(DumpUtil.class);

  /**
   * @param cd
   */
  public static void dumpCalendarData(final CalendarDataType cd) {
    final StringBuilder sb = new StringBuilder("  ");
    logger.debug(sb.toString());

    if (cd.getComp() != null) {
      dumpComp(cd.getComp(), "    ");
    }

    if (cd.getExpand() != null) {
      dumpUTCTimeRange(cd.getExpand(), "expand", "    ");
    }

    if (cd.getLimitRecurrenceSet() != null) {
      dumpUTCTimeRange(cd.getLimitRecurrenceSet(),
                       "limit-recurrence-set", "    ");
    }

    if (cd.getLimitFreebusySet() != null) {
      dumpUTCTimeRange(cd.getLimitFreebusySet(),
                       "limit-freebusy-set", "    ");
    }

    logger.debug("  ");
  }

  /**
   * @param comp
   * @param indent
   */
  public static void dumpComp(final CompType comp,
                              final String indent) {
    StringBuffer sb = new StringBuffer(indent);

    sb.append("");
    logger.debug(sb.toString());

    if (comp.getAllcomp() != null) {
      logger.debug(indent + "  ");
    } else {
      for (CompType c: comp.getComp()) {
        dumpComp(c, indent + "  ");
      }
    }

    if (comp.getAllprop() != null) {
      logger.debug(indent + "  ");
    } else {
      for (PropType prop: comp.getProp()) {
        dumpProp(prop, indent + "  ");
      }
    }

    logger.debug(indent + "");
  }

  /** Debugging
   *
   * @param prop
   * @param indent
   */
  public static void dumpProp(final PropType prop,
                              final String indent) {
    final StringBuilder sb = new StringBuilder(indent);

    sb.append("");

    logger.debug(sb.toString());
  }

  /**
   * @param tr
   * @param name
   * @param indent
   */
  public static void dumpUTCTimeRange(final UTCTimeRangeType tr,
                                      final String name,
                                      final String indent) {
    StringBuilder sb = new StringBuilder(indent);

    sb.append("<");
    sb.append(name);
    sb.append(" ");

    if (tr.getStart() != null) {
      sb.append("start=");
      sb.append(tr.getStart());
    }

    if (tr.getEnd() != null) {
      if (tr.getStart() != null) {
        sb.append(" ");
      }
      sb.append("end=");
      sb.append(tr.getEnd());
    }

    sb.append("/>");

    logger.debug(sb.toString());
  }

  /**
   * @param f
   */
  public static void dumpFilter(final FilterType f) {
    logger.debug("");
    dumpCompFilter(f.getCompFilter(), "  ");
    logger.debug("");
  }


  /** Debug
   *
   * @param cf
   * @param indent
   */
  public static void dumpCompFilter(final CompFilterType cf,
                                    final String indent) {
    final StringBuilder sb = new StringBuilder(indent);

    sb.append("");
    logger.debug(sb.toString());

    if (cf.getIsNotDefined() != null) {
      logger.debug(indent + "  " + "");
    } else if (cf.getTimeRange() != null) {
      dumpUTCTimeRange(cf.getTimeRange(), "time-range",
                       indent + "  ");
    }

    if (cf.getCompFilter() != null) {
      for (CompFilterType subcf: cf.getCompFilter()) {
        dumpCompFilter(subcf, indent + "  ");
      }
    }

    if (cf.getPropFilter() != null) {
      for (PropFilterType pf: cf.getPropFilter()) {
        dumpPropFilter(pf, indent + "  ");
      }
    }

    logger.debug(indent + "");
  }

  /** Debug
   *
   * @param pf
   * @param indent
   */
  public static void dumpPropFilter(final PropFilterType pf,
                                    final String indent) {
    final StringBuilder sb = new StringBuilder(indent);

    sb.append("\n");
    logger.debug(sb.toString());

    if (pf.getIsNotDefined() != null) {
      logger.debug(indent + "  " + "\n");
    } else if (pf.getTimeRange() != null) {
      dumpUTCTimeRange(pf.getTimeRange(), "time-range",
                       indent + "  ");
    } else if (pf.getTextMatch() != null) {
      dumpTextMatch(pf.getTextMatch(), indent + "  ");
    }

    if (pf.getParamFilter() != null) {
      for (ParamFilterType parf: pf.getParamFilter()) {
        dumpParamFilter(parf, indent + "  ");
      }
    }

    logger.debug(indent + "");
  }

  /** Debug
   *
   * @param pf
   * @param indent
   */
  public static void dumpParamFilter(final ParamFilterType pf,
                                     final String indent) {
    final StringBuilder sb = new StringBuilder(indent);

    sb.append("\n");
    logger.debug(sb.toString());

    if (pf.getIsNotDefined() != null) {
      logger.debug(indent + "  " + "\n");
    } else {
      dumpTextMatch(pf.getTextMatch(), indent + "  ");
    }

    logger.debug(indent + "");
  }

  /** Debug
   *
   * @param tm
   * @param indent
   */
  public static void dumpTextMatch(final TextMatchType tm,
                                   final String indent) {
    final StringBuilder sb = new StringBuilder(indent);

    sb.append("");
    logger.debug(sb.toString());

    logger.debug(tm.getValue());

    logger.debug(indent + "\n");
  }
}