/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2010, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.annotations;

import org.hibernate.cache.spi.access.AccessType;

Cache concurrency strategy.
Author:
Emmanuel Bernard/**
 * Cache concurrency strategy.
 *
 * @author Emmanuel Bernard
 */
public enum CacheConcurrencyStrategy {
	
Indicates no concurrency strategy should be applied.
/**
	 * Indicates no concurrency strategy should be applied.
	 */
	NONE( null ),
	
Indicates that read-only strategy should be applied.
See Also:
READ_ONLY.READ_ONLY/**
	 * Indicates that read-only strategy should be applied.
	 *
	 * @see AccessType#READ_ONLY
	 */
	READ_ONLY( AccessType.READ_ONLY ),
	
Indicates that the non-strict read-write strategy should be applied.
See Also:
NONSTRICT_READ_WRITE.NONSTRICT_READ_WRITE/**
	 * Indicates that the non-strict read-write strategy should be applied.
	 *
	 * @see AccessType#NONSTRICT_READ_WRITE
	 */
	NONSTRICT_READ_WRITE( AccessType.NONSTRICT_READ_WRITE ),
	
Indicates that the read-write strategy should be applied.
See Also:
READ_WRITE.READ_WRITE/**
	 * Indicates that the read-write strategy should be applied.
	 *
	 * @see AccessType#READ_WRITE
	 */
	READ_WRITE( AccessType.READ_WRITE ),
	
Indicates that the transaction strategy should be applied.
See Also:
TRANSACTIONAL.TRANSACTIONAL/**
	 * Indicates that the transaction strategy should be applied.
	 *
	 * @see AccessType#TRANSACTIONAL
	 */
	TRANSACTIONAL( AccessType.TRANSACTIONAL );

	private final AccessType accessType;

	private CacheConcurrencyStrategy(AccessType accessType) {
		this.accessType = accessType;
	}

	
Get the AccessType corresponding to this concurrency strategy.
Returns:
The corresponding concurrency strategy. Note that this will return null for NONE/**
	 * Get the AccessType corresponding to this concurrency strategy.
	 *
	 * @return The corresponding concurrency strategy.  Note that this will return {@code null} for
	 * {@link #NONE}
	 */
	public AccessType toAccessType() {
		return accessType;
	}

	
Conversion from AccessType to CacheConcurrencyStrategy. 
Params:
accessType – The access type to convert
Returns:
The corresponding enum value. NONE is returned by default if unable to recognize accessType or if accessType is null./**
	 * Conversion from {@link AccessType} to {@link CacheConcurrencyStrategy}.
	 *
	 * @param accessType The access type to convert
	 *
	 * @return The corresponding enum value.  {@link #NONE} is returned by default if unable to
	 * recognize {@code accessType} or if {@code accessType} is {@code null}.
	 */
	public static CacheConcurrencyStrategy fromAccessType(AccessType accessType) {
		if ( null == accessType ) {
			return NONE;
		}
		
		switch ( accessType ) {
			case READ_ONLY: {
				return READ_ONLY;
			}
			case READ_WRITE: {
				return READ_WRITE;
			}
			case NONSTRICT_READ_WRITE: {
				return NONSTRICT_READ_WRITE;
			}
			case TRANSACTIONAL: {
				return TRANSACTIONAL;
			}
			default: {
				return NONE;
			}
		}
	}

	
Parse an external representation of a CacheConcurrencyStrategy value.
Params:
name – The external representation
Returns:
The corresponding enum value, or null if not match was found./**
	 * Parse an external representation of a CacheConcurrencyStrategy value.
	 *
	 * @param name The external representation
	 *
	 * @return The corresponding enum value, or {@code null} if not match was found.
	 */
	public static CacheConcurrencyStrategy parse(String name) {
		if ( READ_ONLY.isMatch( name ) ) {
			return READ_ONLY;
		}
		else if ( READ_WRITE.isMatch( name ) ) {
			return READ_WRITE;
		}
		else if ( NONSTRICT_READ_WRITE.isMatch( name ) ) {
			return NONSTRICT_READ_WRITE;
		}
		else if ( TRANSACTIONAL.isMatch( name ) ) {
			return TRANSACTIONAL;
		}
		else if ( NONE.isMatch( name ) ) {
			return NONE;
		}
		else {
			return null;
		}
	}

	private boolean isMatch(String name) {
		return ( accessType != null && accessType.getExternalName().equalsIgnoreCase( name ) )
				|| name().equalsIgnoreCase( name );
	}
}