Movatterモバイル変換

Skip to content

BackendJava/java-design-patternsPublic

forked fromiluwatar/java-design-patterns

NotificationsYou must be signed in to change notification settings
Fork0
Star1

Commit991ba32

baislsl

committed

Improve Javadoc

1 parentd78434f commit991ba32Copy full SHA for 991ba32

File tree

30 files changed

+88

-80

lines changed

caching/src/main/java/com/iluwatar/caching
- App.java
dao/src/main/java/com/iluwatar/dao
- InMemoryCustomerDao.java
data-bus/src/main/java/com/iluwatar/databus
- App.java
event-driven-architecture/src/main/java/com/iluwatar/eda
- App.java
factory-kit/src/main/java/com/iluwatar/factorykit
- App.java
feature-toggle/src/main/java/com/iluwatar/featuretoggle
- App.java
- pattern
  - Service.java
  - propertiesversion
    - PropertiesFeatureToggleVersion.java
  - tieredversion
    - TieredFeatureToggleVersion.java
guarded-suspension/src/main/java/com/iluwatar/guarded/suspension
- GuardedQueue.java
half-sync-half-async/src/main/java/com/iluwatar/halfsynchalfasync
- App.java
hexagonal/src/main/java/com/iluwatar/hexagonal
- App.java
naked-objects/webapp/src/main/java/domainapp/webapp
- SimpleApplication.java
observer/src/main/java/com/iluwatar/observer/generic
- Observable.java
reactor/src/main/java/com/iluwatar/reactor
- app
  - App.java
  - AppClient.java
- framework
reader-writer-lock/src/main/java/com/iluwatar/reader/writer/lock
- ReaderWriterLock.java
resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization
- App.java
service-locator/src/main/java/com/iluwatar/servicelocator
- Service.java
singleton/src/main/java/com/iluwatar/singleton
- App.java
- ThreadSafeDoubleCheckLocking.java
step-builder/src/main/java/com/iluwatar/stepbuilder
- App.java
thread-pool/src/main/java/com/iluwatar/threadpool
- Worker.java
throttling/src/main/java/com/iluwatar/throttling
- App.java
value-object/src
- main/java/com/iluwatar/value/object
  - HeroStat.java
- test/java/com/iluwatar/value/object
  - HeroStatTest.java

30 files changed

+88

-80

lines changed

`‎caching/src/main/java/com/iluwatar/caching/App.java`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -52,12 +52,12 @@`
`52`	`52`	`* whether the data is coming from the cache or the DB (i.e. separation of concern). The AppManager`
`53`	`53`	`* ({@link AppManager}) handles the transaction of data to-and-from the underlying data store`
`54`	`54`	`* (depending on the preferred caching policy/strategy).`
`55`		`- *`
`56`		`- * <i>App --> AppManager --> CacheStore/LRUCache/CachingPolicy --> DBManager</i>`
	`55`	`+ * <p>`
	`56`	`+ * <i>{@literalApp --> AppManager --> CacheStore/LRUCache/CachingPolicy --> DBManager}</i>`
`57`	`57`	`* </p>`
`58`	`58`	`*`
`59`	`59`	`* @see CacheStore`
`60`		`- * @See LRUCache`
	`60`	`+ * @see LruCache`
`61`	`61`	`* @see CachingPolicy`
`62`	`62`	`*`
`63`	`63`	`*/`

`‎dao/src/main/java/com/iluwatar/dao/InMemoryCustomerDao.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`/**`
`32`	`32`	`* An in memory implementation of {@link CustomerDao}, which stores the customers in JVM memory`
`33`	`33`	`* and data is lost when the application exits.`
`34`		`- * <br/>`
	`34`	`+ * <br>`
`35`	`35`	`* This implementation is useful as temporary database or for testing.`
`36`	`36`	`*/`
`37`	`37`	`publicclassInMemoryCustomerDaoimplementsCustomerDao {`

`‎data-bus/src/main/java/com/iluwatar/databus/App.java`

Lines changed: 1 addition & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,7 @@`
`34`	`34`	`/**`
`35`	`35`	`* The Data Bus pattern`
`36`	`36`	`* <p>`
`37`		`- * <p>{@see http://wiki.c2.com/?DataBusPattern}</p>`
`38`		`- * <p>`
	`37`	`+ * @see <a href="http://wiki.c2.com/?DataBusPattern">http://wiki.c2.com/?DataBusPattern</a>`
`39`	`38`	`* <p>The Data-Bus pattern provides a method where different parts of an application may`
`40`	`39`	`* pass messages between each other without needing to be aware of the other's existence.</p>`
`41`	`40`	`* <p>Similar to the {@code ObserverPattern}, members register themselves with the {@link DataBus}`

`‎event-driven-architecture/src/main/java/com/iluwatar/eda/App.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`/**`
`34`	`34`	`* An event-driven architecture (EDA) is a framework that orchestrates behavior around the`
`35`	`35`	`* production, detection and consumption of events as well as the responses they evoke. An event is`
`36`		`- * any identifiable occurrence that has significance for system hardware or software. <p/> The`
	`36`	`+ * any identifiable occurrence that has significance for system hardware or software. <p> The`
`37`	`37`	`* example below uses an {@link EventDispatcher} to link/register {@link Event} objects to their`
`38`	`38`	`* respective handlers once an {@link Event} is dispatched, it's respective handler is invoked and`
`39`	`39`	`* the {@link Event} is handled accordingly.`

`‎factory-kit/src/main/java/com/iluwatar/factorykit/App.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public class App {`
`45`	`45`	`/**`
`46`	`46`	`* Program entry point.`
`47`	`47`	`*`
`48`		`- * @param args@param argscommand line args`
	`48`	`+ * @param args command line args`
`49`	`49`	`*/`
`50`	`50`	`publicstaticvoidmain(String[]args) {`
`51`	`51`	`WeaponFactoryfactory =WeaponFactory.factory(builder -> {`

`‎feature-toggle/src/main/java/com/iluwatar/featuretoggle/App.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ public class App {`
`67`	`67`	`* @see UserGroup`
`68`	`68`	`* @see Service`
`69`	`69`	`* @see PropertiesFeatureToggleVersion`
`70`		`- * @see com.iluwatar.featuretoggle.pattern.tieredversion.TieredFeatureToggleVersion;`
	`70`	`+ * @see com.iluwatar.featuretoggle.pattern.tieredversion.TieredFeatureToggleVersion`
`71`	`71`	`*/`
`72`	`72`	`publicstaticvoidmain(String[]args) {`
`73`	`73`

`‎feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/Service.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public interface Service {`
`47`	`47`	`/**`
`48`	`48`	`* Returns if the welcome message to be displayed will be the enhanced version.`
`49`	`49`	`*`
`50`		`- * @return Boolean {@value true} if enhanced.`
	`50`	`+ * @return Boolean {@code true} if enhanced.`
`51`	`51`	`*/`
`52`	`52`	`booleanisEnhanced();`
`53`	`53`

`‎feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/propertiesversion/PropertiesFeatureToggleVersion.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public String getWelcomeMessage(final User user) {`
`91`	`91`	`* see the value of the boolean that was set in the constructor`
`92`	`92`	`* {@link PropertiesFeatureToggleVersion#PropertiesFeatureToggleVersion(Properties)}`
`93`	`93`	`*`
`94`		`- * @return Boolean value {@value true} if enhanced.`
	`94`	`+ * @return Boolean value {@code true} if enhanced.`
`95`	`95`	`*/`
`96`	`96`	`@Override`
`97`	`97`	`publicbooleanisEnhanced() {`

`‎feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/tieredversion/TieredFeatureToggleVersion.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public String getWelcomeMessage(User user) {`
`65`	`65`	`* is driven by the user group. This method is a little redundant. However can be used to show that there is an`
`66`	`66`	`* enhanced version available.`
`67`	`67`	`*`
`68`		`- * @return Boolean value {@value true} if enhanced.`
	`68`	`+ * @return Boolean value {@code true} if enhanced.`
`69`	`69`	`*/`
`70`	`70`	`@Override`
`71`	`71`	`publicbooleanisEnhanced() {`

`‎guarded-suspension/src/main/java/com/iluwatar/guarded/suspension/GuardedQueue.java`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`* Guarded Queue is an implementation for Guarded Suspension Pattern`
`33`	`33`	`* Guarded suspension pattern is used to handle a situation when you want to execute a method`
`34`	`34`	`* on an object which is not in a proper state.`
`35`		`- * @see http://java-design-patterns.com/patterns/guarded-suspension/`
	`35`	`+ * @see<a href="http://java-design-patterns.com/patterns/guarded-suspension/">http://java-design-patterns.com/patterns/guarded-suspension/</a>`
`36`	`36`	`*/`
`37`	`37`	`publicclassGuardedQueue {`
`38`	`38`	`privatestaticfinalLoggerLOGGER =LoggerFactory.getLogger(GuardedQueue.class);`

0 commit comments

Comments

(0)

[8]ページ先頭

©2009-2025 Movatter.jp