diff options
| author | Reinier Zwitserloot <reinier@zwitserloot.com> | 2017-05-08 21:28:02 +0200 |
|---|---|---|
| committer | Reinier Zwitserloot <reinier@zwitserloot.com> | 2017-05-29 21:02:54 +0200 |
| commit | 8b7a7cbc813653a3248d6cf3a7779e220957bc85 (patch) | |
| tree | b9acfb9d68c6866acc3cfb9ee59d72ff43f1ebc3 /website/templates | |
| parent | 72fd50b9f1db1ab6bfc1753ba6a1e686a2f0f22c (diff) | |
| download | lombok-8b7a7cbc813653a3248d6cf3a7779e220957bc85.tar.gz lombok-8b7a7cbc813653a3248d6cf3a7779e220957bc85.tar.bz2 lombok-8b7a7cbc813653a3248d6cf3a7779e220957bc85.zip | |
The great rename: the old ‘website’ is now ‘website-old’, and ‘website2’ is now ‘website’.
Diffstat (limited to 'website/templates')
44 files changed, 2493 insertions, 0 deletions
diff --git a/website/templates/_scaffold.html b/website/templates/_scaffold.html new file mode 100644 index 00000000..f0198fa3 --- /dev/null +++ b/website/templates/_scaffold.html @@ -0,0 +1,118 @@ +<#macro feature title href> + <div class="bs-callout bs-callout-danger"> + <h4><a href="${href}"><code>${title}</code></a></h4> + <p><#nested></p> + </div> +</#macro> + +<#macro scaffold load=[]> + <!DOCTYPE html> + <html lang="en"> + <head> + <meta charset="utf-8" /> + <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /> + <meta name="google-site-verification" content="uCgX3Or3kDRGpbJ6JCsQc3Ub4JsnR5-p0itfsKAYZ_U" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <link href="/favicon.ico" rel="icon" type="image/x-icon" /> + + <title>Project Lombok</title> + + <script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script> + + <link href="/css/bootstrap.css" rel="stylesheet" /> + <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet" /> + + <link href="/css/custom.css" rel="stylesheet" /> + + <#list load as ld> + <#if ld?ends_with(".css")> + <link href="${ld?url_path}" rel="stylesheet" /> + </#if> + </#list> + <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + <script src="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.2.0/js/bootstrap.min.js"></script> + + <script src="/js/swfobject.js"></script> + <script src="/js/history.js"></script> + <script src="/js/main.js"></script> + <#list load as ld> + <#if ld?ends_with(".js")> + <script src="${ld?url_path}"></script> + </#if> + </#list> + </head><body> + <a href="https://github.com/rzwitserloot/lombok" class="fork-me"> + <img + alt="Fork me on GitHub" + src="//s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" /> + </a> + + <div class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <a href="/" class="navbar-brand">Lombok Project</a> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#navbar-main"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse" id="navbar-main"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a class="dropdown-toggle pointer" data-toggle="dropdown">Features<span class="caret"></span></a> + <ul class="dropdown-menu" aria-labelledby="themes"> + <li><a href="/features/all">Stable</a></li> + <li><a href="/features/experimental/all">Experimental</a></li> + </ul> + </li> + <li> + <a href="https://groups.google.com/group/project-lombok" target="_blank"> + <span>Discuss/Help</span> + </a> + </li> + <li> + <a href="https://wiki.github.com/rzwitserloot/lombok/contributing" target="_blank"> + <span>Contribute</span> + </a> + </li> + <li class="dropdown"> + <a class="dropdown-toggle pointer" data-toggle="dropdown">Install<span class="caret"></span></a> + <ul class="dropdown-menu" aria-labelledby="themes"> + <li class="header">Compilers</li> + <li class="target"><a href="/setup/javac">Javac</a></li> + <li class="target"><a href="/setup/ecj">ecj</a></li> + <li class="divider"></li> + <li class="header">IDEs</li> + <li class="target"><a href="/setup/eclipse">Eclipse</a></li> + <li class="target"><a href="/setup/intellij">IntelliJ IDEA</a></li> + <li class="target"><a href="/setup/netbeans">Netbeans</a></li> + <li class="target"><a href="/setup/eclipse">MyEclipse</a></li> + <li class="target"><a href="/setup/eclipse">Spring Tool Suite</a></li> + <li class="target"><a href="/setup/eclipse">JBoss Developer Studio</a></li> + <li class="divider"></li> + <li class="header">Platforms</li> + <li class="target"><a href="/setup/android">Android</a></li> + <li class="target"><a href="/setup/gwt">GWT</a></li> + </ul> + </li> + <li><a href="/download">Download</a></li> + </ul> + </div> + </div> + </div> + <div class="container-fluid main-section" id="main-section"> + <#nested> + </div> + <footer class="container"> + <footer class="footer text-center"> + <div class="container"> + <a href="/credits">credits</a> | Copyright © 2009-${year} The Project Lombok + Authors, licensed under the <a href="http://www.opensource.org/licenses/mit-license.php">MIT + license</a>. + </div> + </footer> + </footer> + </body> +</html> +</#macro> diff --git a/website/templates/all-versions.html b/website/templates/all-versions.html new file mode 100644 index 00000000..d3acd648 --- /dev/null +++ b/website/templates/all-versions.html @@ -0,0 +1,144 @@ +<#import "/_scaffold.html" as main> +<@main.scaffold> + <div class="page-header top5"> + <div> + <div class="row page-center"> + <div> + <h1 class="text-center"> + <div class="row"> + <icon class="fa fa-download"></icon> + <a> + Download ${version} + </a> + </div> + <#list linksToVersions as lnk> + <a href="${lnk[0]}">${lnk[1]}</a> + </#list> + <div class="row"> + <a href="#/changelog"> + changelog + </a> + </div> + </h1> + </div> + </div> + <div class="row"> + <div class="text-center"> + <h3> + Feeling adventurous? Download the latest <a href="lombok-edge.jar">snapshot</a> + release. + </h3> + </div> + </div> + </div> + + <!--<div class="row">--> + + <!--<table class="table table-bordered">--> + <!--<tr>--> + <!--<td class="platform">Maven, Ivy or Gradle</td>--> + <!--<td class="instruction">Lombok is in maven central. <a href="mavenrepo/index.html">More…</a>--> + <!--</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Javac</td>--> + <!--<td class="instruction">Just put <code>lombok.jar</code> on the classpath.</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">NetBeans</td>--> + <!--<td class="instruction">Just put <code>lombok.jar</code> on the classpath and enable annotation--> + <!--processing. <a href="setup/netbeans.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Eclipse and variants</td>--> + <!--<td class="instruction">Run <code>lombok.jar</code> as a java app (i.e. doubleclick it, usually) to--> + <!--install. Also add lombok.jar to your project. <span style="font-size: 0.8em;"><em>Supported--> + <!--variants: Springsource Tool Suite, JBoss Developer Studio</em></span></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">IDEA IntelliJ</td>--> + <!--<td class="instruction"><a href="https://code.google.com/p/lombok-intellij-plugin/">A plugin--> + <!--developed by Michael Plushnikov</a> adds support for most features.--> + <!--</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Javadoc</td>--> + <!--<td class="instruction">First delombok your code then run javadoc on the result. <a--> + <!--href="features/delombok.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Android</td>--> + <!--<td class="instruction">The proper way to use lombok with android is somewhat complicated but--> + <!--possible. <a href="setup/android.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">GWT</td>--> + <!--<td class="instruction">Lombok works with GWT. <a href="setup/gwt.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Play! Framework</td>--> + <!--<td class="instruction">Use Aaron Freeman's <a--> + <!--href="https://github.com/aaronfreeman/play-lombok#readme">lombok play plugin</a>.--> + <!--</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">ecj</td>--> + <!--<td class="instruction">Lombok works on ecj and ecj-based tools. <a--> + <!--href="setup/ecj.html">More…</a></td>--> + <!--</tr>--> + <!--</table>--> + <!--<p style="font-size: 0.9em">--> + <!--Or, <a href="http://code.google.com/p/projectlombok/downloads/list">download</a> a previous version of--> + <!--lombok.--> + <!--</p>--> + <!--</div>--> + <!-- + + + <li><a href="downloads/lombok-1.16.4.jar">lombok-1.16.4.jar</a></li> ++ <li><a href="downloads/lombok-1.16.2.jar">lombok-1.16.2.jar</a></li> ++ <li><a href="downloads/lombok-1.16.0.jar">lombok-1.16.0.jar</a></li> ++ <li><a href="downloads/lombok-1.14.8.jar">lombok-1.14.8.jar</a></li> ++ <li><a href="downloads/lombok-1.14.6.jar">lombok-1.14.6.jar</a></li> ++ <li><a href="downloads/lombok-1.14.4.jar">lombok-1.14.4.jar</a></li> ++ <li><a href="downloads/lombok-1.14.2.jar">lombok-1.14.2.jar</a></li> ++ <li><a href="downloads/lombok-1.14.0.jar">lombok-1.14.0.jar</a></li> ++ <li><a href="downloads/lombok-1.12.6.jar">lombok-1.12.6.jar</a></li> ++ <li><a href="downloads/lombok-1.12.4.jar">lombok-1.12.4.jar</a></li> ++ <li><a href="downloads/lombok-1.12.2.jar">lombok-1.12.2.jar</a></li> ++ <li><a href="downloads/lombok-0.12.0.jar">lombok-0.12.0.jar</a></li> ++ <li><a href="downloads/lombok-0.11.8.jar">lombok-0.11.8.jar</a></li> ++ <li><a href="downloads/lombok-0.11.6.jar">lombok-0.11.6.jar</a></li> ++ <li><a href="downloads/lombok-0.11.4.jar">lombok-0.11.4.jar</a></li> ++ <li><a href="downloads/lombok-0.11.2.jar">lombok-0.11.2.jar</a></li> ++ <li><a href="downloads/lombok-0.11.0.jar">lombok-0.11.0.jar</a></li> ++ <li><a href="downloads/lombok-0.10.8.jar">lombok-0.10.8.jar</a></li> ++ <li><a href="downloads/lombok-0.10.6.jar">lombok-0.10.6.jar</a></li> ++ <li><a href="downloads/lombok-0.10.4.jar">lombok-0.10.4.jar</a></li> ++ <li><a href="downloads/lombok-0.10.2.jar">lombok-0.10.2.jar</a></li> ++ <li><a href="downloads/lombok-0.10.1.jar">lombok-0.10.1.jar</a></li> ++ <li><a href="downloads/lombok-0.10.0.jar">lombok-0.10.0.jar</a></li> ++ <li><a href="downloads/lombok-0.9.3.jar">lombok-0.9.3.jar</a></li> ++ <li><a href="downloads/lombok-0.9.2.jar">lombok-0.9.2.jar</a></li> ++ <li><a href="downloads/lombok-0.9.1.jar">lombok-0.9.1.jar</a></li> ++ <li><a href="downloads/lombok-0.9.0.jar">lombok-0.9.0.jar</a></li> ++ <li><a href="downloads/lombok-0.8.jar">lombok-0.8.jar</a></li> ++ <li><a href="downloads/lombok-0.8.5.jar">lombok-0.8.5.jar</a></li> ++ <li><a href="downloads/lombok-0.8.4.jar">lombok-0.8.4.jar</a></li> ++ <li><a href="downloads/lombok-0.8.3.jar">lombok-0.8.3.jar</a></li> ++ <li><a href="downloads/lombok-0.8.2.jar">lombok-0.8.2.jar</a></li> ++ <li><a href="downloads/lombok-0.8.1.jar">lombok-0.8.1.jar</a></li> ++ <li><a href="downloads/lombok-0.4.jar">lombok-0.4.jar</a></li> + +--> + </div> +</@main.scaffold> diff --git a/website/templates/changelog.html b/website/templates/changelog.html new file mode 100644 index 00000000..80697e70 --- /dev/null +++ b/website/templates/changelog.html @@ -0,0 +1,11 @@ +<#import "/_scaffold.html" as main> +<@main.scaffold> + <div class="page-header top5"> + <div class="row text-center"> + <h1>Changelog</h1> + </div> + <div class="row text-center"> + <h1>@CHANGELOG@</h1> + </div> + </div> +</@main.scaffold> diff --git a/website/templates/credits.html b/website/templates/credits.html new file mode 100644 index 00000000..9e929256 --- /dev/null +++ b/website/templates/credits.html @@ -0,0 +1,50 @@ +<#import "/_scaffold.html" as main> + +<@main.scaffold> + <div class="page-header top5"> + <div class="row text-center"> + <h1>Project Lombok - About the authors and everyone that's helped us create Project Lombok.</h1> + </div> + <div class="row"> + <div class="credits"> + <div class="committers personList"> + <h3>Regular contributors to Project Lombok:</h3> + + <div class="row text-center"> + <div class="person col-md-2"> + <div class="imgCt"><img class="reinierImg" src="/img/reinier.jpg" /></div> + <span class="name">Reinier Zwitserloot</span> + </div> + <div class="person col-md-2"> + <div class="imgCt"><img class="roelImg" src="/img/roel.jpg" /></div> + <span class="name">Roel Spilker</span> + </div> + </div> + </div> + <div class="thanks"> + We'd like to thank: + <ul> + <li> + <strong>Perry Nguyen</strong> (pfn on ##java on freenode) for creating the inspiration for project lombok. + </li><li> + <strong>Tor Norbye</strong>, <strong>Jan Lahoda</strong>, and <strong>Petr Jiricka</strong> for helping out with Netbeans internals and/or javac. + </li><li> + All contributors who submitted patches or helped answering questions!</li> + </ul> + + as well as the authors of the following tools that we use: + + <ul> + <li> + <a href="https://github.com/">Github</a> for hosting lombok's repository and issue tracker. + </li><li> + The <a href="http://asm.ow2.org/index.html">ASM team</a> at ObjectWeb for creating an excellent class file editing tool. Lombok uses ASM to interact with Eclipse. + </li><li> + <strong>Markus Gebhard</strong> for creating <a href="http://java2html.de/">java2html</a> which we use for the example code snippets on the features pages. + </li> + </ul> + </div> + </div> + </div> + </div> +</@main.scaffold> diff --git a/website/templates/disable-checked-exceptions.html b/website/templates/disable-checked-exceptions.html new file mode 100644 index 00000000..94dd433e --- /dev/null +++ b/website/templates/disable-checked-exceptions.html @@ -0,0 +1,24 @@ +<div class="page-header top5"> + <div class="row text-center"> + <h1 class="text-center">Tired of checked exceptions?</h1> + </div> + <div class="row"> + <p> + This lombok spinoff project consists of a hack that only works in javac - not eclipse or any other IDE.<br /> + It will completely disable the notion of checked exceptions. You may throw any exception anywhere, and you may also catch any exception anywhere. In standard javac, you may not catch a checked exception that is not declared as thrown by at least 1 statement in your try block, unless it is <code>Exception</code> or <code>Throwable</code>.<br /> + This restriction is lifted as well. + </p> + </div> + <div class="row"> + <h2 class="text-center">Usage</h2> + + <p> + Just make sure <code>disableCheckedExceptions-alpha.jar</code> is on the classpath as you compile. For example:<br /> + <code>javac -cp disableCheckedExceptions-alpha.jar MySource.java</code> + </p><p> + Ready to try it out? download it here: <a href="/downloads/disableCheckedExceptions-alpha.jar">disableCheckedExceptions-alpha.jar</a> + </p><p> + Want to know how its done? Grab the lombok repository <a href="https://github.com/rzwitserloot/lombok/tree/disableCheckedExceptions">here on github</a>, and look in the <code>experimental</code> directory. + </p> + </div> +</div> diff --git a/website/templates/download.html b/website/templates/download.html new file mode 100644 index 00000000..af992c39 --- /dev/null +++ b/website/templates/download.html @@ -0,0 +1,102 @@ +<#import "/_scaffold.html" as main> +<@main.scaffold> + <div class="page-header top5"> + <div> + <div class="row page-center"> + <div> + <h1 class="text-center"> + <div class="row"> + <icon class="fa fa-download"></icon> + <a> + Download ${version} + </a> + </div> + <div class="row"> + <a href="#/changelog"> + changelog + </a> + </div> + </h1> + </div> + </div> + <div class="row"> + <div class="text-center"> + <h3> + Feeling adventurous? Download the latest <a href="lombok-edge.jar">snapshot</a> + release. + </h3> + </div> + </div> + </div> + + <!--<div class="row">--> + + <!--<table class="table table-bordered">--> + <!--<tr>--> + <!--<td class="platform">Maven, Ivy or Gradle</td>--> + <!--<td class="instruction">Lombok is in maven central. <a href="mavenrepo/index.html">More…</a>--> + <!--</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Javac</td>--> + <!--<td class="instruction">Just put <code>lombok.jar</code> on the classpath.</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">NetBeans</td>--> + <!--<td class="instruction">Just put <code>lombok.jar</code> on the classpath and enable annotation--> + <!--processing. <a href="/setup/netbeans.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Eclipse and variants</td>--> + <!--<td class="instruction">Run <code>lombok.jar</code> as a java app (i.e. doubleclick it, usually) to--> + <!--install. Also add lombok.jar to your project. <span style="font-size: 0.8em;"><em>Supported--> + <!--variants: Springsource Tool Suite, JBoss Developer Studio</em></span></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">IDEA IntelliJ</td>--> + <!--<td class="instruction"><a href="https://github.com/mplushnikov/lombok-intellij-plugin">A plugin--> + <!--developed by Michael Plushnikov</a> adds support for most features.--> + <!--</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Javadoc</td>--> + <!--<td class="instruction">First delombok your code then run javadoc on the result. <a--> + <!--href="/features/delombok">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Android</td>--> + <!--<td class="instruction">The proper way to use lombok with android is somewhat complicated but--> + <!--possible. <a href="/setup/android.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">GWT</td>--> + <!--<td class="instruction">Lombok works with GWT. <a href="setup/gwt.html">More…</a></td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">Play! Framework</td>--> + <!--<td class="instruction">Use Aaron Freeman's <a--> + <!--href="https://github.com/aaronfreeman/play-lombok#readme">lombok play plugin</a>.--> + <!--</td>--> + <!--</tr>--> + + <!--<tr>--> + <!--<td class="platform">ecj</td>--> + <!--<td class="instruction">Lombok works on ecj and ecj-based tools. <a--> + <!--href="setup/ecj.html">More…</a></td>--> + <!--</tr>--> + <!--</table>--> + <!--<p style="font-size: 0.9em">--> + <!--Or, <a href="/all-versions">download</a> a previous version of--> + <!--lombok.--> + <!--</p>--> + <!--</div>--> + </div> +</@main.scaffold> diff --git a/website/templates/features/Builder.html b/website/templates/features/Builder.html new file mode 100644 index 00000000..a6b8d18f --- /dev/null +++ b/website/templates/features/Builder.html @@ -0,0 +1,163 @@ +<#import "_features.html" as f> + +<@f.scaffold title="@Builder" logline="... and Bob's your uncle: No-hassle fancy-pants APIs for object creation!"> + <@f.history> + <p> + <code>@Builder</code> was introduced as experimental feature in lombok v0.12.0. + </p><p> + <code>@Builder</code> gained <code>@Singular</code> support and was promoted to the main <code>lombok</code> package since lombok v1.16.0. + </p><p> + <code>@Builder</code> with <code>@Singular</code> adds a clear method since lombok v1.16.8. + </p><p> + <code>@Builder.Default</code> functionality was added in lombok v1.16.16. + </p> + </@f.history> + + <@f.overview> + <p> + The <code>@Builder</code> annotation produces complex builder APIs for your classes. + </p><p> + <code>@Builder</code> lets you automatically produce the code required to have your class be instantiable with code such as:<br /> + <code>Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").job("Unchained Reaction").build();</code> + </p><p> + <code>@Builder</code> can be placed on a class, or on a constructor, or on a method. While the "on a class" and "on a constructor" mode are the most common use-case, <code>@Builder</code> is most easily explained with the "method" use-case. + </p><p> + A method annotated with <code>@Builder</code> (from now on called the <em>target</em>) causes the following 7 things to be generated: + <ul> + <li> + An inner static class named <code><em>Foo</em>Builder</code>, with the same type arguments as the static method (called the <em>builder</em>). + </li><li> + In the <em>builder</em>: One private non-static non-final field for each parameter of the <em>target</em>. + </li><li> + In the <em>builder</em>: A package private no-args empty constructor. + </li><li> + In the <em>builder</em>: A 'setter'-like method for each parameter of the <em>target</em>: It has the same type as that parameter and the same name. It returns the |