Skip to content

Commit f38598b

Browse files
committed
update jex docs
1 parent 1cbd1e5 commit f38598b

File tree

3 files changed

+28
-31
lines changed

3 files changed

+28
-31
lines changed

http-client/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1254,7 +1254,7 @@ <h3 id="at-client-import">@Client.Import</h3>
12541254
</p>
12551255

12561256
<h5>Example client import</h5>
1257-
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Client.Import</span><span class="o">(</span><span class="nx">types</span> <span class="o">=</span> <span class="nx">org</span><span class="o">.</span><span class="na field">foo</span><span class="o">.</span><span class="na field">MyInterface</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
1257+
<div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Client.Import</span><span class="o">(</span><span class="nx">org</span><span class="o">.</span><span class="na field">foo</span><span class="o">.</span><span class="na field">MyInterface</span><span class="o">.</span><span class="na">class</span><span class="o">)</span>
12581258
<span class="kn">package</span> <span class="nn">org.bar</span><span class="o">;</span>
12591259

12601260
<span class="kn">import</span> <span class="nn">io.avaje.http.api.Client</span><span class="o">;</span>

jex/index.html

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
</li>
4444
<li><a href="#alternate">Alternate Implementations</a>
4545
<ul>
46-
<li><a href="#robaho">Robaho</a></li>
4746
<li><a href="#jetty">Jetty</a></li>
47+
<li><a href="#robaho">Robaho</a></li>
4848
</ul>
4949
</li>
5050
</ul>
@@ -98,6 +98,7 @@ <h1 id="overview">Avaje Jex</h1>
9898
<li>Json (de)serialization SPI</li>
9999
<li>Automatic Compression</li>
100100
<li>Context abstraction over HttpExchange to easily retrieve and send request/response data.</li>
101+
<li>Multi-Server with any implementation of jdk.httpserver (Jetty, Robaho, built-in, etc)</li>
101102
</ul>
102103

103104
<h2 id="quick-start">Quick Start</h2>
@@ -301,7 +302,7 @@ <h3 id="ctx">Context</h3>
301302
response.
302303
</p>
303304

304-
<p>See the <a href="https://javadoc.io/doc/io.avaje/avaje-jex/latest/io.avaje.jex/io/avaje/jex/Context.html"> Context
305+
<p>See the <a href="https://javadoc.io/doc/io.avaje/avaje-jex/latest/io.avaje.jex/io/avaje/jex/http/Context.html"> Context
305306
Javadoc</a> for a description of all the methods available</p>
306307
<details>
307308
<summary>Some <em>Context</em> Methods: (click to expand) </summary>
@@ -414,8 +415,8 @@ <h3 id="ctx">Context</h3>
414415
<td>Returns map of all query parameters.</td>
415416
</tr>
416417
<tr>
417-
<td><strong><code>url()</code></strong></td>
418-
<td>Returns request url.</td>
418+
<td><strong><code>uri()</code></strong></td>
419+
<td>Returns request uri.</td>
419420
</tr>
420421
<tr>
421422
<td><strong><code>fullUrl()</code></strong></td>
@@ -723,7 +724,7 @@ <h2 id="config">Server Configuration</h2>
723724

724725
<h2 id="ssl">Configuring Https</h2>
725726
<p>
726-
The JDK HttpsServer can be configured using a <code>HttpsConfigurator</code> instance to provide SSL termination.
727+
The underlying HttpsServer can be configured using a <code>HttpsConfigurator</code> instance to provide SSL termination.
727728
The below example demonstrates how to configure a <code>HttpsConfigurator</code> with an <code>SSLContext</code>.
728729
</p>
729730

@@ -763,30 +764,9 @@ <h2 id="ssl">Configuring Https</h2>
763764

764765
<h2 id="alternate">Alternate HttpServer Implementations</h2>
765766

766-
<p>The JDK provides an SPI to swap the underlying <code>HttpServer</code>, so you can easily use jex with
767+
<p>The JDK provides an SPI to swap the underlying <code>HttpServer</code>, so you can easily use jex as a wrapper for
767768
alternate implementations by adding them as a dependency.</p>
768769

769-
<h3 id="robaho">Robaho</h3>
770-
771-
<p><a href="https://github.com/robaho/httpserver">Robaho's
772-
server</a> is a zero-dependency implementation with some key optimizations. In certain benchmarks, performance seems
773-
to be increased by 10x over the built-in server and up to 5x over the jetty implementation.</p>
774-
<a href="https://mvnrepository.com/artifact/io.github.robaho/httpserver"><img
775-
src="https://img.shields.io/maven-central/v/io.github.robaho/httpserver.svg?label=robaho.version"></a>
776-
<br></br>
777-
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt">&lt;dependency&gt;</span>
778-
<span class="nt">&lt;groupId&gt;</span>io.avaje<span class="nt">&lt;/groupId&gt;</span>
779-
<span class="nt">&lt;artifactId&gt;</span>avaje-jex<span class="nt">&lt;/artifactId&gt;</span>
780-
<span class="nt">&lt;version&gt;</span>&#36;{jex.version}<span class="nt">&lt;/version&gt;</span>
781-
<span class="nt">&lt;/dependency&gt;</span>
782-
<span class="nt">&lt;dependency&gt;</span>
783-
<span class="nt">&lt;groupId&gt;</span>io.github.robaho<span class="nt">&lt;/groupId&gt;</span>
784-
<span class="nt">&lt;artifactId&gt;</span>httpserver<span class="nt">&lt;/artifactId&gt;</span>
785-
<span class="nt">&lt;version&gt;</span>&#36;{robaho.version}<span class="nt">&lt;/version&gt;</span>
786-
<span class="nt">&lt;/dependency&gt;</span>
787-
</pre></div>
788-
</div>
789-
790770
<h3 id="jetty">Jetty</h3>
791771

792772
<p>Jetty is a classic embedded server with a long and distinguished history.</p>
@@ -813,6 +793,26 @@ <h3 id="jetty">Jetty</h3>
813793
</pre></div>
814794
</div>
815795

796+
<h3 id="robaho">Robaho</h3>
797+
798+
<p><a href="https://github.com/robaho/httpserver">Robaho's
799+
server</a> is a zero-dependency implementation with some key optimizations. In certain benchmarks, performance seems
800+
to be increased by 10x over the built-in server and up to 5x over the jetty implementation.</p>
801+
<a href="https://mvnrepository.com/artifact/io.github.robaho/httpserver"><img
802+
src="https://img.shields.io/maven-central/v/io.github.robaho/httpserver.svg?label=robaho.version"></a>
803+
<br></br>
804+
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt">&lt;dependency&gt;</span>
805+
<span class="nt">&lt;groupId&gt;</span>io.avaje<span class="nt">&lt;/groupId&gt;</span>
806+
<span class="nt">&lt;artifactId&gt;</span>avaje-jex<span class="nt">&lt;/artifactId&gt;</span>
807+
<span class="nt">&lt;version&gt;</span>&#36;{jex.version}<span class="nt">&lt;/version&gt;</span>
808+
<span class="nt">&lt;/dependency&gt;</span>
809+
<span class="nt">&lt;dependency&gt;</span>
810+
<span class="nt">&lt;groupId&gt;</span>io.github.robaho<span class="nt">&lt;/groupId&gt;</span>
811+
<span class="nt">&lt;artifactId&gt;</span>httpserver<span class="nt">&lt;/artifactId&gt;</span>
812+
<span class="nt">&lt;version&gt;</span>&#36;{robaho.version}<span class="nt">&lt;/version&gt;</span>
813+
<span class="nt">&lt;/dependency&gt;</span>
814+
</pre></div>
815+
</div>
816816
<p><br><br><br><br><br><br></p>
817817

818818
</article>

validator/index.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -963,9 +963,6 @@ <h3 id="adapter">@ConstraintAdapter</h3>
963963

964964
<span class="nd">@Override</span>
965965
<span class="kd">public</span> <span class="kt">boolean</span> <span class="nf">isValid</span><span class="o">(</span><span class="n">String</span> <span class="n">object</span><span class="o">)</span> <span class="o">{</span>
966-
<span class="k">if</span> <span class="o">(</span><span class="n">object</span> <span class="o">==</span> <span class="kc">null</span><span class="o">)</span> <span class="o">{</span>
967-
<span class="k">return</span> <span class="kc">true</span><span class="o">;</span>
968-
<span class="o">}</span>
969966
<span class="k">if</span> <span class="o">(</span><span class="n">caseMode</span> <span class="o">==</span> <span class="n">CaseMode</span><span class="o">.</span><span class="na">UPPER</span><span class="o">)</span> <span class="o">{</span>
970967
<span class="k">return</span> <span class="n">object</span><span class="o">.</span><span class="na">equals</span><span class="o">(</span><span class="n">object</span><span class="o">.</span><span class="na">toUpperCase</span><span class="o">());</span>
971968
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>

0 commit comments

Comments
 (0)