Edit Javadoc.

This commit is contained in:
John Blum
2019-05-06 12:57:25 -07:00
parent 97f17557ca
commit c2e90b9c17
4 changed files with 19 additions and 8 deletions

View File

@@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package example.app.caching.lookaside;
import org.springframework.boot.WebApplicationType;
@@ -21,9 +20,12 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
/**
* The BootGeodeLookAsideCachingApplication class...
* {@link SpringBootApplication} to configure and bootstrap the example application using the Look-Aside Caching pattern,
* and specifically Spring's Cache Abstraction with Apache Geode as the caching provider.
*
* @author John Blum
* @see org.springframework.boot.autoconfigure.SpringBootApplication
* @see org.springframework.boot.builder.SpringApplicationBuilder
* @since 1.0.0
*/
@SpringBootApplication

View File

@@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package example.app.caching.lookaside.config;
import org.apache.geode.cache.client.ClientRegionShortcut;
@@ -22,9 +21,13 @@ import org.springframework.data.gemfire.config.annotation.EnableCachingDefinedRe
import org.springframework.data.gemfire.config.annotation.EnableLogging;
/**
* The GeodeConfiguration class...
* Spring {@link Configuration} class used to configure Apache Geode.
*
* @author John Blum
* @see org.apache.geode.cache.client.ClientRegionShortcut
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.data.gemfire.config.annotation.EnableCachingDefinedRegions
* @see org.springframework.data.gemfire.config.annotation.EnableClusterConfiguration
* @since 1.0.0
*/
@SuppressWarnings("unused")

View File

@@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package example.app.caching.lookaside.contoller;
import org.springframework.util.Assert;
@@ -24,9 +23,12 @@ import org.springframework.web.bind.annotation.RestController;
import example.app.caching.lookaside.service.CounterService;
/**
* The CounterController class...
* A Spring Web MVC {@link RestController} used to expose the {@link CounterService} operations via HTTP
* in a REST-ful interface.
*
* @author John Blum
* @see org.springframework.web.bind.annotation.GetMapping
* @see org.springframework.web.bind.annotation.RestController
* @since 1.0.0
*/
@SuppressWarnings("unused")

View File

@@ -13,7 +13,6 @@
* or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package example.app.caching.lookaside.service;
import java.util.concurrent.ConcurrentHashMap;
@@ -26,9 +25,14 @@ import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;
/**
* The CounterService class...
* A Spring Cacheable {@link Service} class used to maintain a collection of named counters and provide counter
* operations to increment the count, access the current, cached count and rest the count.
*
* @author John Blum
* @see org.springframework.cache.annotation.CacheEvict
* @see org.springframework.cache.annotation.CachePut
* @see org.springframework.cache.annotation.Cacheable
* @see org.springframework.stereotype.Service
* @since 1.0.0
*/
// tag::class[]