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 a74029813 Javadocs
a74029813 is described below
commit a7402981334c8158fe5b44f2fbfa6d7af9f99377
Author: JamesBognar <[email protected]>
AuthorDate: Sat Jun 11 10:46:48 2022 -0400
Javadocs
---
.../juneau/config/internal/package-info.java | 18 +++++++
.../org/apache/juneau/http/header/HeaderList.java | 2 +-
.../java/org/apache/juneau/http/part/PartList.java | 1 -
.../Topics/02.juneau-marshall/23.jm.Encoders.html | 62 +++++++++++++++++++++-
.../Topics/02.juneau-marshall/25.jm.PojoTools.html | 12 ++++-
.../examples/core/config/store/package-info.java | 18 +++++++
.../juneau/examples/parser/package-info.java | 18 +++++++
.../juneau/examples/serializer/package-info.java | 18 +++++++
.../org/apache/juneau/rest/debug/package-info.java | 18 +++++++
.../apache/juneau/rest/httppart/package-info.java | 18 +++++++
.../org/apache/juneau/rest/rrpc/package-info.java | 18 +++++++
.../apache/juneau/rest/servlet/package-info.java | 18 +++++++
.../juneau/rest/staticfile/package-info.java | 18 +++++++
.../apache/juneau/rest/swagger/package-info.java | 18 +++++++
14 files changed, 252 insertions(+), 5 deletions(-)
diff --git
a/juneau-core/juneau-config/src/main/java/org/apache/juneau/config/internal/package-info.java
b/juneau-core/juneau-config/src/main/java/org/apache/juneau/config/internal/package-info.java
new file mode 100755
index 000000000..3bcc8c446
--- /dev/null
+++
b/juneau-core/juneau-config/src/main/java/org/apache/juneau/config/internal/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * Internal classes
+ */
+package org.apache.juneau.config.internal;
+
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/HeaderList.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/HeaderList.java
index 4c48d8230..f1b2a6208 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/HeaderList.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/header/HeaderList.java
@@ -149,7 +149,7 @@ import org.apache.juneau.svl.*;
* }
*
* <jc>// Use it on a remote proxy to add headers on all requests.</jc>
- * <ja>@Remote</ja>(path=<js>"/petstore"</js>,
headerList=MyHeaderList.<jk>class</jk>)
+ * <ja>@Remote</ja>(path=<js>"/petstore"</js>,
headerList=MyHeaderList.<jk>class</jk>)
* <jk>public interface</jk> PetStore {
*
* <ja>@RemotePost</ja>(<js>"/pets"</js>)
diff --git
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/part/PartList.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/part/PartList.java
index 3d3c94b90..dfb8ead8e 100644
---
a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/part/PartList.java
+++
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/part/PartList.java
@@ -32,7 +32,6 @@ import org.apache.juneau.svl.*;
/**
* An immutable list of HTTP parts (form-data, query-parameters,
path-parameters).
- * {@review}
*
* <h5 class='figure'>Example</h5>
* <p class='bjava'>
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/23.jm.Encoders.html
b/juneau-doc/docs/Topics/02.juneau-marshall/23.jm.Encoders.html
index 73edf7969..d95cd5f6f 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/23.jm.Encoders.html
+++ b/juneau-doc/docs/Topics/02.juneau-marshall/23.jm.Encoders.html
@@ -13,10 +13,68 @@
***************************************************************************************************************************/
-->
-{title:'Encoders', created:'9.0.0', flags:'TODO'}
+{title:'Encoders', created:'9.0.0'}
<div class='topic'>
<p>
- TODO
+ The {@link org.apache.juneau.encoders} package defines an API
for handling encoding-based matching
+ of <c>Accept-Encoding</c>/<c>Content-Encoding</c> HTTP headers.
It consists of the following classes:
+ </p>
+ <ul class='javatree'>
+ <li class='jc'>{@link oaj.encoders.EncoderSet}
+ <li class='jcc'>{@link oaj.encoders.Encoder}
+ <ul>
+ <li class='jc'>{@link oaj.encoders.IdentityEncoder}
+ <li class='jc'>{@link oaj.encoders.GzipEncoder}
+ </ul>
+ </ul>
+ <h5 class='topic'>EncoderSet</h5>
+ <p>
+ The {@link oaj.encoders.EncoderSet} class represents the set of
{@link Encoder encoders} keyed by codings.
+ It maintains a set of encoders and the codings that they can
handle.
+ The {@link oaj.encoders.EncoderSet#getEncoderMatch(String)
getEncoderMatch(String)} and {@link oaj.encoders.EncoderSet#getEncoder(String)}
+ methods are then used to find appropriate encoders for specific
<c>Accept-Encoding</c> and <c>Content-Encoding</c> header values.
+ </p>
+
+ <h5 class='topic'>Match ordering</h5>
+ <p>
+ Encoders are tried in the order they appear in the set. The
{@link oaj.encoders.EncoderSet.Builder#add(Class...)} / {@link
oaj.encoders.EncoderSet.Builder#add(Encoder...)}
+ methods prepend the values to the list to allow them the
opportunity to override encoders already in the list.
+ </p>
+ <p>
+ For example, calling
<code>builder.add(E1.<jk>class</jk>,E2.<jk>class</jk>).add(E3.<jk>class</jk>,
+ E4.<jk>class</jk>)</code> will result in the order <c>E3, E4,
E1, E2</c>.
+ </p>
+
+ <h5 class='section'>Example:</h5>
+ <p class='bjava'>
+ | <jc>// Create an encoder group with support for gzip
compression.</jc>
+ | EncoderSet <jv>encoders</jv> = EncoderSet
+ | .<jsm>create</jsm>()
+ | .add(GzipEncoder.<jk>class</jk>)
+ | .build();
+ |
+ | <jc>// Should return "gzip"</jc>
+ | String <jv>matchedCoding</jv> =
<jv>encoders</jv>.findMatch(<js>"compress;q=1.0, gzip;q=0.8, identity;q=0.5,
*;q=0"</js>);
+ |
+ | <jc>// Get the encoder</jc>
+ | Encoder <jv>encoder</jv> =
<jv>encoders</jv>.getEncoder(<jv>matchedCoding</jv>);
+ </p>
+
+ <h5 class='topic'>Encoder API</h5>
+ <p>
+ The {@link oaj.encoders.Encoder} interface is used for enabling
decompression on requests and compression on responses, such as support for
GZIP compression.
+ It is used to wrap input and output streams within
compression/decompression streams.
+ </p>
+ <ul class='javatree'>
+ <li class='jac'>{@link oaj.encoders.Encoder}
+ <ul class='javatreec'>
+ <li class='jm'>{@link oaj.encoders.Encoder#getCodings()
getCodings()}
+ <li class='jm'>{@link
oaj.encoders.Encoder#getInputStream(InputStream) getInputStream(InputStream)}
+ <li class='jm'>{@link
oaj.encoders.Encoder#getOutputStream(OutputStream)
getOutputStream(OutputStream)}
+ </ul>
+ </ul>
+ <p>
+ Encoders are registered with <c>RestServlets</c> through the
<ja>@Rest(encoders)</ja> annotation.
</p>
</div>
\ No newline at end of file
diff --git a/juneau-doc/docs/Topics/02.juneau-marshall/25.jm.PojoTools.html
b/juneau-doc/docs/Topics/02.juneau-marshall/25.jm.PojoTools.html
index 282fdc8a6..67e3ab7bd 100644
--- a/juneau-doc/docs/Topics/02.juneau-marshall/25.jm.PojoTools.html
+++ b/juneau-doc/docs/Topics/02.juneau-marshall/25.jm.PojoTools.html
@@ -17,6 +17,16 @@
<div class='topic'>
<p>
- TODO
+ The {@link org.apache.juneau.pojotools} package defines
convenience utility classes for accessing
+ and manipulating POJOs. It consists of the following classes:
</p>
+ <ul class='javatree'>
+ <li class='jc'>{@link oaj.encoders.EncoderSet}
+ <li class='jcc'>{@link oaj.encoders.Encoder}
+ <ul>
+ <li class='jc'>{@link oaj.encoders.IdentityEncoder}
+ <li class='jc'>{@link oaj.encoders.GzipEncoder}
+ </ul>
+ </ul>
+
</div>
\ No newline at end of file
diff --git
a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/config/store/package-info.java
b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/config/store/package-info.java
new file mode 100755
index 000000000..8d3cd131f
--- /dev/null
+++
b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/core/config/store/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * Examples
+ */
+package org.apache.juneau.examples.core.config.store;
+
diff --git
a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/parser/package-info.java
b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/parser/package-info.java
new file mode 100755
index 000000000..8bce6f7b8
--- /dev/null
+++
b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/parser/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * Examples
+ */
+package org.apache.juneau.examples.parser;
+
diff --git
a/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/serializer/package-info.java
b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/serializer/package-info.java
new file mode 100755
index 000000000..9597cee00
--- /dev/null
+++
b/juneau-examples/juneau-examples-core/src/main/java/org/apache/juneau/examples/serializer/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * Examples
+ */
+package org.apache.juneau.examples.serializer;
+
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/debug/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/debug/package-info.java
new file mode 100755
index 000000000..7a34d0456
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/debug/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * REST Debug APIs
+ */
+package org.apache.juneau.rest.debug;
+
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/httppart/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/httppart/package-info.java
new file mode 100755
index 000000000..6fe8fdd2f
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/httppart/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * REST HTTP Parts
+ */
+package org.apache.juneau.rest.httppart;
+
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/rrpc/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/rrpc/package-info.java
new file mode 100755
index 000000000..cedfdf768
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/rrpc/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * REST Remote Procedure Call API
+ */
+package org.apache.juneau.rest.rrpc;
+
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/servlet/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/servlet/package-info.java
new file mode 100755
index 000000000..b70a092c8
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/servlet/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * REST Servlets
+ */
+package org.apache.juneau.rest.servlet;
+
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/staticfile/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/staticfile/package-info.java
new file mode 100755
index 000000000..5bb045f13
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/staticfile/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * REST Static Files Support
+ */
+package org.apache.juneau.rest.staticfile;
+
diff --git
a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/swagger/package-info.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/swagger/package-info.java
new file mode 100755
index 000000000..459ea6329
--- /dev/null
+++
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/swagger/package-info.java
@@ -0,0 +1,18 @@
+//
***************************************************************************************************************************
+// * Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file *
+// * distributed with this work for additional information regarding copyright
ownership. The ASF licenses this file *
+// * to you under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance *
+// * with the License. You may obtain a copy of the License at
*
+// *
*
+// * http://www.apache.org/licenses/LICENSE-2.0
*
+// *
*
+// * Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an *
+// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express or implied. See the License for the *
+// * specific language governing permissions and limitations under the
License. *
+//
***************************************************************************************************************************
+
+/**
+ * REST Swagger Support
+ */
+package org.apache.juneau.rest.swagger;
+
