licenses

Author: Shawn Hartsock

src/main/java/com/pssd/cache/CacheFactory.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 import com.pssd.cache.errors.ConfigurationFoundButNotAccessableException;
@@ -13,15 +30,19 @@
 import java.util.LinkedList;
 
 /**
- * The basic idea here is to build caches based on objects.
+ * The basic idea here is to build caches based on objects. You would assemble a POJO that was appropriate for use
+ * as a key in a hash. This would be an object that held all the salient variables for the method. Then you back off
+ * your particular method into an anonymous inner class implementing the CacheableFunction interface.
+ * <p/>
+ * In the testing directory, the class SimpleCacheUser shows one of the simplest ways to use this Caching API.
  * <p/>
  * @author Shawn Hartsock
  */
 public class CacheFactory {
     /**
      * The singleton owner of caches in this system.
      */
-    final static CacheManager cacheManager = new CacheManager();
+    final static CacheManager cacheManager = new CacheManager(); //TODO: allow configuration from XML in classpath
 
     /**
      * builds a CacheConfiguration object based on properties
@@ -190,3 +211,4 @@ private static Object put(final Ehcache cache, final Object parameter, final Cac
         return result;
     }
 }
+

src/main/java/com/pssd/cache/CacheableFunction.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 /**
@@ -21,3 +38,4 @@
 public interface CacheableFunction<P,T> {
     T cached(P parameter);
 }
+

src/main/java/com/pssd/cache/Configuration.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 import net.sf.ehcache.config.CacheConfiguration;
@@ -150,3 +167,4 @@ public int hashCode() {
         return result;
     }
 }
+

src/main/java/com/pssd/cache/LambdaCache.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 /**
@@ -9,4 +26,5 @@
  */
 public interface LambdaCache<P,T> {
     T invoke(CacheableFunction<P,T> cacheableFunction, P parameter);
-}
+}
+

src/main/java/com/pssd/cache/errors/ConfigurationFoundButNotAccessableException.java

@@ -1,7 +1,25 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache.errors;
 
 public class ConfigurationFoundButNotAccessableException extends IllegalStateException {
     public ConfigurationFoundButNotAccessableException(Class owner, String name) {
         super("found static field " + name + " on " + owner.getCanonicalName() + " but could not access");
     }
 }
+

src/main/java/com/pssd/cache/errors/NoConfigurationFoundException.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache.errors;
 
 public class NoConfigurationFoundException extends IllegalStateException {
@@ -9,3 +26,4 @@ public NoConfigurationFoundException(final Class owner,final String name) {
         super("could not find static field " + name + " on " + owner.getCanonicalName());
     }
 }
+

src/test/java/com/pssd/cache/CacheFactoryConfigurationMethodTests.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 import net.sf.ehcache.config.CacheConfiguration;
@@ -56,3 +73,4 @@ private void assertCorrectFifoCacheConfiguration(Configuration configuration) {
     }
 
 }
+

src/test/java/com/pssd/cache/CacheFactoryTests.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 import net.sf.ehcache.config.CacheConfiguration;
@@ -26,3 +43,4 @@ public void testSimpleCacheUserNamedCacheCorrectResult() {
 
     }
 }
+

src/test/java/com/pssd/cache/SimpleCacheUser.java

@@ -1,3 +1,20 @@
+/* License added by: GRADLE-LICENSE-PLUGIN
+ *
+ * Copyright (C) 2012 Shawn Hartsock <[email protected]>
+ * 
+ * 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 com.pssd.cache;
 
 public class SimpleCacheUser {
@@ -22,3 +39,4 @@ public Integer cached(String number) {
         });
     }
 }
+