javax.cache.annotation.impl.AbstractInternalCacheKeyInvocationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cache-annotations-ri-common Show documentation
The newest version!
/**
 *  Copyright 2011 Terracotta, Inc.
 *  Copyright 2011 Oracle America Incorporated
 *
 *  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
 *
 *      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 javax.cache.annotation.impl;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.List;

import javax.cache.annotation.CacheInvocationParameter;


/**
 * Provides caching specific context about an intercepted method invocation.
 * 
 * NOTE: This class uses arrays instead of immutable collections due to the frequency of these objects
 * being created. In testing creating new arrays and cloning them requires less CPU time and fewer objects
 * than creating new immutable Lists.
 * 
 * @author Eric Dalquist
 * @param  The intercepted method invocation
 * @param  The type of annotation this context information is for. One of {@link javax.cache.annotation.CacheResult},
 * {@link javax.cache.annotation.CachePut}, {@link javax.cache.annotation.CacheRemoveEntry}, or
 * {@link javax.cache.annotation.CacheRemoveAll}.
 * @since 1.0
 */
public abstract class AbstractInternalCacheKeyInvocationContext 
        extends AbstractInternalCacheInvocationContext
        implements InternalCacheKeyInvocationContext {
    
    private final StaticCacheKeyInvocationContext staticCacheKeyInvocationContext;
    private final CacheInvocationParameter[] keyParameters;
    private final CacheInvocationParameter valueParameter;
    
    /**
     * Create a AbstractInternalCacheInvocationContext
     * 
     * @param staticCacheKeyInvocationContext The pre-processed method details data
     * @param invocation The current invocation context
     */
    public AbstractInternalCacheKeyInvocationContext(StaticCacheKeyInvocationContext staticCacheKeyInvocationContext, 
            I invocation) {
        
        super(staticCacheKeyInvocationContext, invocation);
        
        this.staticCacheKeyInvocationContext = staticCacheKeyInvocationContext;

        final CacheInvocationParameter[] allParameters = this.getAllParameters();
        
        //Build array of key CacheParameterDetails from CacheParameterDetails List
        final List keyParameterDetails = staticCacheKeyInvocationContext.getKeyParameters();
        this.keyParameters = new CacheInvocationParameter[keyParameterDetails.size()];
        int pIdx = 0;
        for (final CacheParameterDetails parameterDetails : keyParameterDetails) {
            final int parameterPosition = parameterDetails.getParameterPosition();
            this.keyParameters[pIdx++] = allParameters[parameterPosition];
        }
        
        //If this is for a CachePut get the CacheInvocationParameter for the CacheValue
        if (staticCacheKeyInvocationContext.getInterceptorType() == InterceptorType.CACHE_PUT) {
            final CachePutMethodDetails cachePutMethodDetails = (CachePutMethodDetails)staticCacheKeyInvocationContext;
            final CacheParameterDetails cacheValueParameter = cachePutMethodDetails.getCacheValueParameter();
            final int parameterPosition = cacheValueParameter.getParameterPosition();
            this.valueParameter = allParameters[parameterPosition];
        } else {
            this.valueParameter = null;
        }
    }
    
    
    /* (non-Javadoc)
     * @see javax.cache.annotation.impl.InternalCacheKeyInvocationContext#getStaticCacheKeyInvocationContext()
     */
    @Override
    public StaticCacheKeyInvocationContext getStaticCacheKeyInvocationContext() {
        return this.staticCacheKeyInvocationContext;
    }

    /* (non-Javadoc)
     * @see javax.cache.annotation.impl.AbstractInternalCacheInvocationContext#getParameters(java.lang.Object)
     */
    @Override
    protected Object[] getParameters(I invocation) {
        // TODO Auto-generated method stub
        return null;
    }



    /* (non-Javadoc)
     * @see javax.cache.annotation.impl.AbstractInternalCacheInvocationContext#getMethod(java.lang.Object)
     */
    @Override
    protected Method getMethod(I invocation) {
        // TODO Auto-generated method stub
        return null;
    }



    /* (non-Javadoc)
     * @see javax.cache.annotation.impl.AbstractInternalCacheInvocationContext#getTarget(java.lang.Object)
     */
    @Override
    protected Object getTarget(I invocation) {
        // TODO Auto-generated method stub
        return null;
    }



    /* (non-Javadoc)
     * @see javax.cache.annotation.CacheKeyInvocationContext#getKeyParameters()
     */
    @Override
    public CacheInvocationParameter[] getKeyParameters() {
        return this.keyParameters.clone();
    }

    /* (non-Javadoc)
     * @see javax.cache.annotation.CacheKeyInvocationContext#getValueParameter()
     */
    @Override
    public CacheInvocationParameter getValueParameter() {
        return this.valueParameter;
    }
}