Java development kit for prismic.io
This library is on Maven Central. The kit coordinates are:
<dependency> <groupId>io.prismic</groupId> <artifactId>java-kit</artifactId> <version>1.0.7</version> </dependency>
(you may need to adapt the version number)
The kit requires Java 7 or superior.
Get started with prismic.io
Get started using the kit
Also on our prismic.io developer's portal, on top of our full documentation, you will:
- get a thorough introduction of how to use prismic.io kits, including this one.
- see what else is available for Java: starter projects, examples, ...
Kit's detailed documentation
You can find the documentation on this Javadoc.
Through Java's syntax, this kit contains some mild differences and syntastic sugar over the section of our documentation that tells you how to use prismic.io kits in general (which you should read first). The differences are listed here:
- Traditional POJO getter-and-setter syntaxes are applied; therefore, one calls a SearchForm like this:
- The class usually called
SearchFormis a nested class here, which is called
Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.
Contribute to the kit
Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.
Install the kit locally
mvn test before committing, to make sure everything runs as expected.
If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
Please document any bugfix or new feature using the Javadoc syntax
If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
(Only for Prismic.io developers)
mvn clean javadoc:javadoc scm-publish:publish-scm
This software is licensed under the Apache 2 license, quoted below.
Copyright 2013 Zengularity (http://www.zengularity.com).
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project 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.