Registry.java

/*  
 * Copyright 2008-2014 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
 *
 *     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.kaleidofoundry.core.util;

import java.util.Collection;
import java.util.Collections;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import org.kaleidofoundry.core.lang.annotation.NotNull;
import org.kaleidofoundry.core.lang.annotation.Task;
import org.kaleidofoundry.core.lang.annotation.TaskLabel;
import org.kaleidofoundry.core.lang.annotation.ThreadSafe;

/**
 * Registry pattern, implement with a {@link ConcurrentHashMap} <br/>
 * Contains list of couple <name, class instance>
 * 
 * @author jraduget
 * @param <K>
 * @param <T>
 */
@ThreadSafe
@Task(labels = TaskLabel.Review, comment = "Does ConcurrentHashMap is the best way for performance and concurrency ?")
public class Registry<K, T> extends ConcurrentHashMap<K, T> implements ConcurrentMap<K, T> {

   private static final long serialVersionUID = -2537287170029457353L;

   /**
    * default constructor
    */
   public Registry() {
   }

   /**
    * Set return ware not modifiable
    * 
    * @see java.util.concurrent.ConcurrentHashMap#entrySet()
    */
   @Override
   public Set<Entry<K, T>> entrySet() {
	return Collections.unmodifiableSet(super.entrySet());
   }

   /**
    * Set return ware not modifiable
    * 
    * @see java.util.HashMap#keySet()
    */
   @Override
   public Set<K> keySet() {
	return Collections.unmodifiableSet(super.keySet());
   }

   /**
    * Collection return ware not modifiable
    * 
    * @see java.util.HashMap#values()
    */
   @Override
   public Collection<T> values() {
	return Collections.unmodifiableCollection(super.values());
   }

   /*
    * (non-Javadoc)
    * @see java.util.concurrent.ConcurrentHashMap#get(java.lang.Object)
    */
   @Override
   public T get(@NotNull final Object key) {
	return super.get(key);
   }

   /*
    * (non-Javadoc)
    * @see java.util.concurrent.ConcurrentHashMap#put(java.lang.Object, java.lang.Object)
    */
   @Override
   public T put(@NotNull final K key, @NotNull final T value) {
	return super.put(key, value);
   }

   /*
    * (non-Javadoc)
    * @see java.util.concurrent.ConcurrentHashMap#remove(java.lang.Object)
    */
   @Override
   public T remove(@NotNull final Object key) {
	return super.remove(key);
   }

}