This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new a77a400 Rename PropertyStore to ContextProperties.
a77a400 is described below
commit a77a4006a00f2861a80b2adbc74eed1820131a10
Author: JamesBognar <[email protected]>
AuthorDate: Mon Feb 8 17:43:36 2021 -0500
Rename PropertyStore to ContextProperties.
---
.../main/java/org/apache/juneau/BeanContext.java | 2 +-
.../src/main/java/org/apache/juneau/Context.java | 2 +-
.../java/org/apache/juneau/ContextBuilder.java | 16 ++++++++--------
.../java/org/apache/juneau/ContextProperties.java | 4 ++--
.../apache/juneau/ContextPropertiesBuilder.java | 10 +++++-----
.../11.ContextsBuildersSessionsPropertyStores.html | 22 +++++++++++-----------
.../12.ConfigStores/03.CustomConfigStores.html | 8 ++++----
.../14.RestcExtendingRestClient.html | 2 +-
juneau-doc/src/main/javadoc/resources/docs.txt | 2 +-
.../org/apache/juneau/rest/client/RestClient.java | 8 ++++----
.../java/org/apache/juneau/rest/RestConverter.java | 2 +-
.../java/org/apache/juneau/rest/widget/Widget.java | 2 +-
12 files changed, 40 insertions(+), 40 deletions(-)
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
index 0c41a3b..912b098 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanContext.java
@@ -143,7 +143,7 @@ import org.apache.juneau.utils.ReflectionMapBuilder;
* </p>
*
* <ul class='seealso'>
- * <li class='link'>{@doc ContextsBuildersSessionsPropertyStores}
+ * <li class='link'>{@doc ContextsBuildersSessionsContextProperties}
* </ul>
*/
@SuppressWarnings({"unchecked","rawtypes"})
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
index ae97902..355cdc0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/Context.java
@@ -33,7 +33,7 @@ import org.apache.juneau.transform.*;
* Subclasses MUST implement the following constructor:
*
* <p class='bcode w800'>
- * <jk>public</jk> T(PropertyStore);
+ * <jk>public</jk> T(ContextProperties);
* </p>
*
* <p>
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
index f57f09b..4969b42 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextBuilder.java
@@ -107,16 +107,16 @@ public abstract class ContextBuilder {
* <h5 class='section'>Example:</h5>
* <p class='bcode w800'>
* <jc>// Create a free-form set of properties.</jc>
- * PropertyStore ps = PropertyStore
+ * ContextProperties <jv>properties</jv> = ContextProperties
* .<jsm>create</jsm>()
* .set(<jsf>BEAN_sortMaps</jsf>)
* .set(<jsf>BEAN_sortProperties</jsf>)
* .build();
*
* <jc>// Create a serializer that uses those settings.</jc>
- * WriterSerializer s = JsonSerializer
+ * WriterSerializer <jv>serializer</jv> = JsonSerializer
* .<jsm>create</jsm>()
- * .apply(ps)
+ * .apply(<jv>properties</jv>)
* .build();
* </p>
*
@@ -141,17 +141,17 @@ public abstract class ContextBuilder {
*
<ja>@BeanConfig</ja>(sortProperties=<js>"$S{sortProperties,false}"</js>)
* <jk>public class</jk> MyClass {...}
*
- * <jc>// Find all annotations that themselves are annotated with
@PropertyStoreApply.</jc>
- * AnnotationList al =
ClassInfo.<jsm>of</jsm>(MyClass.<jk>class</jk>)
+ * <jc>// Find all annotations that themselves are annotated with
@ContextPropertiesApply.</jc>
+ * AnnotationList <jv>al</jv> =
ClassInfo.<jsm>of</jsm>(MyClass.<jk>class</jk>)
*
.getAnnotationList(ConfigAnnotationFilter.<jsf>INSTANCE</jsf>);
*
* <jc>// Use the default VarResolver to resolve any variables in
the annotation fields.</jc>
- * VarResolverSession vs =
VarResolver.<jsf>DEFAULT</jsf>.createSession();
+ * VarResolverSession <jv>vs</jv> =
VarResolver.<jsf>DEFAULT</jsf>.createSession();
*
* <jc>// Apply any settings found on the annotations.</jc>
- * WriterSerializer s = JsonSerializer
+ * WriterSerializer <jv>serializer</jv> = JsonSerializer
* .<jsm>create</jsm>()
- * .applyAnnotations(al, vs)
+ * .applyAnnotations(<jv>al</jv>, <jv>vs</jv>)
* .build();
* </p>
*
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextProperties.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextProperties.java
index a3158b6..28090e9 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextProperties.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextProperties.java
@@ -54,7 +54,7 @@ import org.apache.juneau.reflect.*;
* <h5 class='topic'>ContextPropertiesBuilder</h5>
*
* <p>
- * The {@link ContextPropertiesBuilder} class is used to build up and
instantiate immutable <c>PropertyStore</c>
+ * The {@link ContextPropertiesBuilder} class is used to build up and
instantiate immutable <c>ContextProperties</c>
* objects.
*
* <p>
@@ -69,7 +69,7 @@ import org.apache.juneau.reflect.*;
* </p>
*
* <p>
- * Property stores are immutable, comparable, and their hashcodes are
calculated exactly one time.
+ * <c>ContextProperties</c> objects are immutable, comparable, and their
hashcodes are calculated exactly one time.
* That makes them particularly suited for use as hashmap keys, and thus for
caching reusable serializers and parsers.
*
* <h5 class='topic'>Property naming convention</h5>
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextPropertiesBuilder.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextPropertiesBuilder.java
index 40f8774..7f49ad8 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextPropertiesBuilder.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ContextPropertiesBuilder.java
@@ -34,8 +34,8 @@ import org.apache.juneau.svl.*;
*/
public class ContextPropertiesBuilder {
- // Contains a cache of all created PropertyStore objects keyed by
hashcode.
- // Used to minimize memory consumption by reusing identical
PropertyStores.
+ // Contains a cache of all created ContextProperties objects keyed by
hashcode.
+ // Used to minimize memory consumption by reusing identical
ContextProperties.
private static final Map<ContextProperties,ContextProperties> CACHE =
new ConcurrentHashMap<>();
// Maps property suffixes (e.g. "lc") to PropertyType (e.g. LIST_CLASS)
@@ -50,12 +50,12 @@ public class ContextPropertiesBuilder {
// Previously-created property store.
private volatile ContextProperties properties;
- // Called by PropertyStore.builder()
+ // Called by ContextProperties.builder()
ContextPropertiesBuilder(ContextProperties cp) {
apply(cp);
}
- // Called by PropertyStore.create()
+ // Called by ContextProperties.create()
ContextPropertiesBuilder() {}
/**
@@ -622,7 +622,7 @@ public class ContextPropertiesBuilder {
}
/**
- * Clears the PropertyStore cache.
+ * Clears the ContextProperties cache.
*/
public static void clearCache() {
CACHE.clear();
diff --git
a/juneau-doc/docs/Topics/02.juneau-marshall/11.ContextsBuildersSessionsPropertyStores.html
b/juneau-doc/docs/Topics/02.juneau-marshall/11.ContextsBuildersSessionsPropertyStores.html
index 031ab04..3ce9200 100644
---
a/juneau-doc/docs/Topics/02.juneau-marshall/11.ContextsBuildersSessionsPropertyStores.html
+++
b/juneau-doc/docs/Topics/02.juneau-marshall/11.ContextsBuildersSessionsPropertyStores.html
@@ -12,8 +12,8 @@
* specific language governing permissions and limitations under the License.
***************************************************************************************************************************/
-->
-
-Contexts, Builders, Sessions, and PropertyStores
+{9.0.0-updated}
+Contexts, Builders, Sessions, and ContextProperties
<p>
All the serializers, parsers, and REST server/client classes use the
following design pattern:
@@ -35,11 +35,11 @@ Contexts, Builders, Sessions, and PropertyStores
<li>Examples: <c>BeanSession</c>,
<c>JsonSerializerSession</c>
</ul>
<li>
- <l>PropertyStore</l> - A thread-safe read-only set of
configuration properties.
+ <l>ContextProperties</l> - A thread-safe read-only set of
configuration properties.
<ul>
<li>Heavier to create than <c>Sessions</c> but lighter
than <c>Contexts</c>.
- <li>Each <c>Context</c> contains one
<c>PropertyStore</c> that defines all the configuration about that object.
- <li>Created by <l>PropertyStoreBuilder</l> classes.
+ <li>Each <c>Context</c> contains one
<c>ContextProperties</c> that defines all the configuration about that object.
+ <li>Created by <l>ContextPropertiesBuilder</l> classes.
</ul>
</ul>
<p>
@@ -64,7 +64,7 @@ Contexts, Builders, Sessions, and PropertyStores
</ul>
</ul>
<p>
- Each context object in the hierarchy define properties that can be
stored in a <c>PropertyStore</c>
+ Each context object in the hierarchy define properties that can be
stored in a <c>ContextProperties</c>
such as <jsf>WSERIALIZER_useWhitespace</jsf> or
<jsf>JSON_simpleMode</jsf>.
</p>
<p>
@@ -110,7 +110,7 @@ Contexts, Builders, Sessions, and PropertyStores
</ul>
</ul>
<p>
- The general idea behind a {@link oaj.PropertyStore} is to serve as a
reusable configuration of an artifact
+ The general idea behind a {@link oaj.ContextProperties} is to serve as
a reusable configuration of an artifact
(such as a serializer) such that the artifact can be cached and reused
if the property stores are 'equal'.
</p>
<p>
@@ -128,14 +128,14 @@ Contexts, Builders, Sessions, and PropertyStores
serializers and parsers.
</p>
<p>
- The {@link oaj.PropertyStoreBuilder} class is used to build up and
instantiate immutable
- <c>PropertyStore</c> objects.
+ The {@link oaj.ContextPropertiesBuilder} class is used to build up and
instantiate immutable
+ <c>ContextProperties</c> objects.
</p>
<p>
In the example above, the property store being built looks like the
following:
</p>
<p class='bpcode w800'>
- PropertyStore <jv>ps</jv> = PropertyStore
+ ContextProperties <jv>ps</jv> = ContextProperties
.<jsm>create</jsm>()
.set(<js>"BeanContext.swaps.lo"</js>, MySwap.<jk>class</jk>)
.set(<js>"JsonSerializer.simpleMode.b"</js>)
@@ -146,6 +146,6 @@ Contexts, Builders, Sessions, and PropertyStores
That makes them particularly suited for use as hashmap keys, and thus
for caching reusable serializers and parsers.
</p>
<p>
- Refer to the {@link oaj.PropertyStore} javadoc for a detailed
explaination on how
+ Refer to the {@link oaj.ContextProperties} javadoc for a detailed
explanation on how
property stores work.
</p>
diff --git
a/juneau-doc/docs/Topics/05.juneau-config/12.ConfigStores/03.CustomConfigStores.html
b/juneau-doc/docs/Topics/05.juneau-config/12.ConfigStores/03.CustomConfigStores.html
index 41abeea..f9b0374 100644
---
a/juneau-doc/docs/Topics/05.juneau-config/12.ConfigStores/03.CustomConfigStores.html
+++
b/juneau-doc/docs/Topics/05.juneau-config/12.ConfigStores/03.CustomConfigStores.html
@@ -42,7 +42,7 @@ Custom ConfigStores
<jc>// Constructor called from builder.</jc>
- <jk>protected</jk> ConfigSqlStore(PropertyStore <jv>ps</jv>) {
+ <jk>protected</jk> ConfigSqlStore(ContextProperties
<jv>ps</jv>) {
<jk>super</jk>(<jv>ps</jv>);
<jk>this</jk>.<jf>jdbcUrl</jf> =
getStringProperty(<jsf>CONFIGSQLSTORE_jdbcUrl</jsf>,
<js>"jdbc:derby:mydb"</js>);
@@ -126,7 +126,7 @@ Custom ConfigStores
}
</p>
<p>
- The purpose of the builder class is to simply set values in the {@link
oaj.PropertyStore}
+ The purpose of the builder class is to simply set values in the {@link
oaj.ContextProperties}
that's passed to the <c>ConfigStore</c>:
</p>
<h5 class='figure'>Example Builder Class:</h5>
@@ -137,7 +137,7 @@ Custom ConfigStores
<jk>super</jk>();
}
- <jk>public</jk> ConfigSqlStoreBuilder(PropertyStore
<jv>ps</jv>) {
+ <jk>public</jk> ConfigSqlStoreBuilder(ContextProperties
<jv>ps</jv>) {
<jk>super</jk>(<jv>ps</jv>);
}
@@ -168,7 +168,7 @@ Custom ConfigStores
<ja>@Override</ja> <jc>/* ContextBuilder */</jc>
<jk>public</jk> ConfigFileStore build() {
- <jk>return new</jk> ConfigFileStore(getPropertyStore());
+ <jk>return new</jk>
ConfigFileStore(getContextProperties());
}
}
</p>
\ No newline at end of file
diff --git
a/juneau-doc/docs/Topics/09.juneau-rest-client/14.RestcExtendingRestClient.html
b/juneau-doc/docs/Topics/09.juneau-rest-client/14.RestcExtendingRestClient.html
index 4c08ac3..0a8c7cc 100644
---
a/juneau-doc/docs/Topics/09.juneau-rest-client/14.RestcExtendingRestClient.html
+++
b/juneau-doc/docs/Topics/09.juneau-rest-client/14.RestcExtendingRestClient.html
@@ -26,7 +26,7 @@ Extending RestClient
<jk>public class</jk> MyRestClient <jk>extends</jk> RestClient {
<jc>// Must provide this constructor!</jc>
- <jk>public</jk> MyRestClient(PropertyStore <jv>ps</jv>) {
+ <jk>public</jk> MyRestClient(ContextProperties <jv>ps</jv>) {
<jk>super</jk>(<jv>ps</jv>);
}
diff --git a/juneau-doc/src/main/javadoc/resources/docs.txt
b/juneau-doc/src/main/javadoc/resources/docs.txt
index 9e8e7d2..8274096 100644
--- a/juneau-doc/src/main/javadoc/resources/docs.txt
+++ b/juneau-doc/src/main/javadoc/resources/docs.txt
@@ -41,7 +41,7 @@ ConfigStoreListeners =
#juneau-config.ConfigStores.ConfigStoreListeners, Overvie
ConfigStores = #juneau-config.ConfigStores, Overview > juneau-config > Config
Stores
ConfigVariables = #juneau-config.ConfigVariables, Overview > juneau-config >
Variables
ConfigurableAnnotations = #juneau-marshall.ConfigurableAnnotations, Overview >
juneau-marshall > Configurable Annotations
-ContextsBuildersSessionsPropertyStores =
#juneau-marshall.ContextsBuildersSessionsPropertyStores, Overview >
juneau-marshall > Contexts, Builders, Sessions, and PropertyStores
+ContextsBuildersSessionsContextProperties =
#juneau-marshall.ContextsBuildersSessionsContextProperties, Overview >
juneau-marshall > Contexts, Builders, Sessions, and ContextProperties
CoreExamples = #juneau-examples-core.CoreExamples, Overview >
juneau-examples-core > Examples
CoreExamplesInstalling = #juneau-examples-core.CoreExamplesInstalling,
Overview > juneau-examples-core > Installing in Eclipse
CustomConfigStores = #juneau-config.ConfigStores.CustomConfigStores, Overview
> juneau-config > Config Stores > Custom ConfigStores
diff --git
a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
index 6008623..8910c17 100644
---
a/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
+++
b/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestClient.java
@@ -1019,8 +1019,8 @@ import org.apache.juneau.utils.*;
* <jk>public class</jk> MyRestClient <jk>extends</jk> RestClient {
*
* <jc>// Must provide this constructor!</jc>
- * <jk>public</jk> MyRestClient(PropertyStore <jv>ps</jv>) {
- * <jk>super</jk>(<jv>ps</jv>);
+ * <jk>public</jk> MyRestClient(ContextProperties
<jv>properties</jv>) {
+ * <jk>super</jk>(<jv>properties</jv>);
* }
*
* <ja>@Override</ja>
@@ -2056,7 +2056,7 @@ public class RestClient extends BeanContext implements
HttpClient, Closeable, Re
SerializerGroupBuilder sgb = SerializerGroup.create();
for (Object o : cp.getArray(RESTCLIENT_serializers,
Object.class).orElse(new Object[0])) {
if (o instanceof Serializer) {
- sgb.append((Serializer)o); // Don't apply
PropertyStore.
+ sgb.append((Serializer)o); // Don't apply
ContextProperties.
} else if (o instanceof Class) {
Class<?> c = (Class<?>)o;
if (! Serializer.class.isAssignableFrom(c))
@@ -2071,7 +2071,7 @@ public class RestClient extends BeanContext implements
HttpClient, Closeable, Re
ParserGroupBuilder pgb = ParserGroup.create();
for (Object o : cp.getArray(RESTCLIENT_parsers,
Object.class).orElse(new Object[0])) {
if (o instanceof Parser) {
- pgb.append((Parser)o); // Don't apply
PropertyStore.
+ pgb.append((Parser)o); // Don't apply
ContextProperties.
} else if (o instanceof Class) {
Class<?> c = (Class<?>)o;
if (! Parser.class.isAssignableFrom(c))
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
index 5309ea8..48bdb67 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestConverter.java
@@ -60,7 +60,7 @@ import org.apache.juneau.serializer.*;
* Subclasses must implement one of the following constructors:
* <ul>
* <li><jk>public</jk> T(); <jc>// No-arg constructor</jc>
- * <li><jk>public</jk> T(PropertyStore); <jc>// Property store of the
RestContext</jc>
+ * <li><jk>public</jk> T(ContextProperties); <jc>// Property store of the
RestContext</jc>
* </ul>
*
* <p>
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
index 65bfb51..d57056a 100644
---
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/widget/Widget.java
@@ -27,7 +27,7 @@ import org.apache.juneau.http.exception.*;
* Widgets must provide one of the following public constructors:
* <ul>
* <li><code><jk>public</jk> Widget();</code>
- * <li><code><jk>public</jk> Widget(PropertyStore);</code>
+ * <li><code><jk>public</jk> Widget(ContextProperties);</code>
* </ul>
*
* <p>
