juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [juneau] branch master updated: Update Javadocs.
Date Tue, 27 Feb 2018 15:27:04 GMT
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 2457eb3  Update Javadocs.
2457eb3 is described below

commit 2457eb332e819d2e9d01e254f675bd9b4ab62ba3
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Tue Feb 27 10:26:57 2018 -0500

    Update Javadocs.
---
 juneau-doc/src/main/javadoc/overview.html | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 2f88135..482e95d 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -5452,7 +5452,7 @@
 		</ul>
 		<p class='bcode'>
 	<jc>// Construct the sample config file programmatically</jc>
-	Config cf = Config.<jsm>create</jsm>().name(<js>"MyConfig.cfg"</js>).build()
+	Config c = Config.<jsm>create</jsm>().name(<js>"MyConfig.cfg"</js>).build()
 		.set(<js>"key1"</js>, 1)
 		.set(<js>"key2"</js>, <jk>true</jk>)
 		.set(<js>"key3"</js>, <jk>new int</jk>[]{1,2,3})
@@ -5513,6 +5513,21 @@
 	<a id="juneau-config.ReadOnlyConfigs"></a>
 	<h3 class='topic' onclick='toggle(this)'>6.12 - Read-only Configs</h3>
 	<div class='topic'>
+		<p>
+			The following settings can be used to create read-only <code>Config</code>
objects:
+		</p>
+		<ul class='doctree'>
+			<li class='jf'>{@link org.apache.juneau.config.Config#CONFIG_readOnly}
+			<li class='jm'>{@link org.apache.juneau.config.ConfigBuilder#readOnly()}
+		</ul>
+		<h6 class='figure'>Example:</h6>
+		<p class='bcode'>
+	<jc>// Create a read-only config</jc>
+	Config c = Config.<jsm>create</jsm>().name(<js>"MyConfig.cfg"</js>).readOnly().build();
+		</p>
+		<p>
+			This causes all methods that make modifications to throw {@link java.lang.UnsupportedOperationException}.
+		</p>
 	</div>
 
 	<!-- ========================================================================================================
-->

-- 
To stop receiving notification emails like this one, please contact
jamesbognar@apache.org.

Mime
View raw message