core/src/main/java/org/apache/accumulo/core/util/format/DateStringFormatter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.accumulo.core.util.format;

import java.util.Map.Entry;
import java.util.TimeZone;

import org.apache.accumulo.core.data.Key;
import org.apache.accumulo.core.data.Value;

/**
 * This class is <strong>not</strong> recommended because
 * {@link #initialize(Iterable, FormatterConfig)} replaces parameters in {@link FormatterConfig},
 * which could surprise users.
 *
 * This class can be replaced by {@link DefaultFormatter} where FormatterConfig is initialized with
 * a DateFormat set to {@link #DATE_FORMAT}. See
 * {@link DateFormatSupplier#createSimpleFormatSupplier(String, java.util.TimeZone)}.
 *
 * <pre>
 * final DateFormatSupplier dfSupplier = DateFormatSupplier.createSimpleFormatSupplier(
 *     DateFormatSupplier.HUMAN_READABLE_FORMAT, TimeZone.getTimeZone(&quot;UTC&quot;));
 * final FormatterConfig config = new FormatterConfig().setPrintTimestamps(true)
 *     .setDateFormatSupplier(dfSupplier);
 * </pre>
 *
 * @deprecated since 1.8.0
 */
@Deprecated
public class DateStringFormatter implements Formatter {

  private DefaultFormatter defaultFormatter;
  private TimeZone timeZone;

  public static final String DATE_FORMAT = DateFormatSupplier.HUMAN_READABLE_FORMAT;

  public DateStringFormatter() {
    this(TimeZone.getDefault());
  }

  public DateStringFormatter(TimeZone timeZone) {
    this.defaultFormatter = new DefaultFormatter();
    this.timeZone = timeZone;
  }

  @Override
  public void initialize(Iterable<Entry<Key,Value>> scanner, FormatterConfig config) {
    FormatterConfig newConfig = new FormatterConfig(config);
    newConfig.setDateFormatSupplier(
        DateFormatSupplier.createSimpleFormatSupplier(DATE_FORMAT, timeZone));
    defaultFormatter.initialize(scanner, newConfig);
  }

  @Override
  public boolean hasNext() {
    return defaultFormatter.hasNext();
  }

  @Override
  public String next() {
    return defaultFormatter.next();
  }

  @Override
  public void remove() {
    defaultFormatter.remove();
  }

}