geode-core/src/main/java/org/apache/geode/management/internal/configuration/converters/ConfigurationConverter.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.geode.management.internal.configuration.converters;

/**
 * the implementer of each pair of configuration object and xml domain object is
 * reponsible in converting between the two
 *
 * @param <T> the class of the configuration object
 * @param <V> the class of the xml domain object
 */
public abstract class ConfigurationConverter<T, V> {

  public final T fromXmlObject(V xmlObject) {
    if (xmlObject == null) {
      return null;
    }
    return fromNonNullXmlObject(xmlObject);
  }

  /**
   *
   * @param xmlObject is guaranteed not to be null
   * @return the resulting configuration object
   */
  protected abstract T fromNonNullXmlObject(V xmlObject);

  public final V fromConfigObject(T configObject) {
    if (configObject == null) {
      return null;
    }

    return fromNonNullConfigObject(configObject);
  }

  /**
   *
   * @param configObject is guaranteed not to be null
   * @return the resulting xml domain object
   */
  protected abstract V fromNonNullConfigObject(T configObject);

}