#354 Finish Readme

2016-02-01 18:45:54 +00:00
parent b27d6dff66
commit 37da470178
10 changed files with 82 additions and 32 deletions
--- a/feature-toggle/src/main/java/com/iluwatar/featuretoggle/App.java
+++ b/feature-toggle/src/main/java/com/iluwatar/featuretoggle/App.java
@ -1,17 +1,17 @@
 /**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
- *
+ * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
- *
+ * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
- *
+ * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
--- a/feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/Service.java
+++ b/feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/Service.java
@ -1,17 +1,17 @@
 /**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
- *
+ * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
- *
+ * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
- *
+ * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
--- a/feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/propertiesversion/PropertiesFeatureToggleVersion.java
+++ b/feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/propertiesversion/PropertiesFeatureToggleVersion.java
@ -1,17 +1,17 @@
 /**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
- *
+ * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
- *
+ * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
- *
+ * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@ -28,7 +28,16 @@ import com.iluwatar.featuretoggle.user.User;
 import java.util.Properties;

 /**
+ * This example of the Feature Toogle pattern is less dynamic version than
+ * {@link com.iluwatar.featuretoggle.pattern.tieredversion.TieredFeatureToggleVersion} where the feature is turned on
+ * or off at the time of creation of the service. This example uses simple Java {@link Properties} however it could as
+ * easily be done with an external configuration file loaded by Spring and so on. A good example of when to use this
+ * version of the feature toggle is when new features are being developed. So you could have a configuration property
+ * boolean named development or some sort of system environment variable.
 *
+ * @see Service
+ * @see com.iluwatar.featuretoggle.pattern.tieredversion.TieredFeatureToggleVersion
+ * @see User
 */
 public class PropertiesFeatureToggleVersion implements Service {

--- a/feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/tieredversion/TieredFeatureToggleVersion.java
+++ b/feature-toggle/src/main/java/com/iluwatar/featuretoggle/pattern/tieredversion/TieredFeatureToggleVersion.java
@ -1,17 +1,17 @@
 /**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
- *
+ * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
- *
+ * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
- *
+ * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@ -27,7 +27,16 @@ import com.iluwatar.featuretoggle.user.User;
 import com.iluwatar.featuretoggle.user.UserGroup;

 /**
+ * This example of the Feature Toogle pattern shows how it could be implemented based on a {@link User}. Therefore
+ * showing its use within a tiered application where the paying users get access to different content or
+ * better versions of features. So in this instance a {@link User} is passed in and if they are found to be
+ * on the {@link UserGroup#isPaid(User)} they are welcomed with a personalised message. While the other is more
+ * generic. However this pattern is limited to simple examples such as the one below.
 *
+ * @see Service
+ * @see User
+ * @see com.iluwatar.featuretoggle.pattern.propertiesversion.PropertiesFeatureToggleVersion
+ * @see UserGroup
 */
 public class TieredFeatureToggleVersion implements Service {

--- a/feature-toggle/src/main/java/com/iluwatar/featuretoggle/user/User.java
+++ b/feature-toggle/src/main/java/com/iluwatar/featuretoggle/user/User.java
@ -1,17 +1,17 @@
 /**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
- *
+ * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
- *
+ * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
- *
+ * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
--- a/feature-toggle/src/main/java/com/iluwatar/featuretoggle/user/UserGroup.java
+++ b/feature-toggle/src/main/java/com/iluwatar/featuretoggle/user/UserGroup.java
@ -1,17 +1,17 @@
 /**
 * The MIT License
 * Copyright (c) 2014 Ilkka Seppälä
- *
+ * <p>
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
- *
+ * <p>
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
- *
+ * <p>
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE