/*
 * Copyright 2010-2019 the original author or authors.
 *
 * Licensed 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
 *
 *       https://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.springframework.data.gemfire.wan;

import org.apache.geode.cache.util.Gateway;

/**
 * The OrderPolicyType class is an enumeration of Pivotal GemFire Gateway Order Policies.
 *
 * @author John Blum
 * @see org.apache.geode.cache.util.Gateway.OrderPolicy
 * @since 1.7.0
 */
@SuppressWarnings({ "deprecation", "unused" })
public enum OrderPolicyType {

	KEY(Gateway.OrderPolicy.KEY),
	PARTITION(Gateway.OrderPolicy.PARTITION),
	THREAD(Gateway.OrderPolicy.THREAD);

	private final Gateway.OrderPolicy orderPolicy;

	/**
	 * Constructs an instance of the OrderPolicyType enum initialized with the matching Pivotal GemFire Gateway.OrderPolicy
	 * enumerated value.
	 *
	 * @param orderPolicy the matching Pivotal GemFire Gateway.OrderPolicy enumerated value.
	 * @see org.apache.geode.cache.util.Gateway.OrderPolicy
	 */
	OrderPolicyType(final Gateway.OrderPolicy orderPolicy) {
		this.orderPolicy = orderPolicy;
	}

	/**
	 * Null-safe operation to extract the matching Pivotal GemFire Gateway.OrderPolicy enumerated value from
	 * the specified OrderPolicyType.
	 *
	 * @param orderPolicyType {@link OrderPolicyType} enum from which to extract the Pivotal GemFire-based
	 * Gateway.OrderPolicy enumerated value.
	 * @return the Pivotal GemFire Gateway.OrderPolicy enumerated value for the given OrderPolicyType.
	 * @see org.apache.geode.cache.util.Gateway.OrderPolicy
	 * @see #getOrderPolicy()
	 */
	public static Gateway.OrderPolicy getOrderPolicy(final OrderPolicyType orderPolicyType) {
		return (orderPolicyType != null ? orderPolicyType.getOrderPolicy() : null);
	}

	/**
	 * Returns the matching OrderPolicyType given a Pivotal GemFire Gateway.OrderPolicy enumerated value.
	 *
	 * @param orderPolicy the Pivotal GemFire Gateway.OrderPolicy enumerated value used to match
	 * the desired OrderPolicyType.
	 * @return a OrderPolicyType matching the given Pivotal GemFire Gateway.OrderPolicy enumerated value.
	 * @see org.apache.geode.cache.util.Gateway.OrderPolicy
	 * @see #getOrderPolicy()
	 */
	public static OrderPolicyType valueOf(final Gateway.OrderPolicy orderPolicy) {
		for (OrderPolicyType orderPolicyType : values()) {
			if (orderPolicyType.getOrderPolicy().equals(orderPolicy)) {
				return orderPolicyType;
			}
		}

		return null;
	}

	/**
	 * Returns a matching OrderPolicyType given the case-insensitive, name of the Pivotal GemFire Gateway OrderPolicy.
	 *
	 * @param name a String name used to match the desired OrderPolicyType.
	 * @return a OrderPolicyType enumerated value for the given name.
	 * @see java.lang.String#equalsIgnoreCase(String)
	 * @see #name()
	 */
	public static OrderPolicyType valueOfIgnoreCase(final String name) {
		for (OrderPolicyType orderPolicy : values()) {
			if (orderPolicy.name().equalsIgnoreCase(name)) {
				return orderPolicy;
			}
		}

		return null;
	}

	/**
	 * Gets the Pivotal GemFire Gateway.OrderPolicy corresponding to this OrderPolicyType enum.
	 *
	 * @return a Pivotal GemFire Gateway.OrderPolicy for this enum.
	 * @see org.apache.geode.cache.util.Gateway.OrderPolicy
	 */
	public Gateway.OrderPolicy getOrderPolicy() {
		return orderPolicy;
	}
}
