Skip to content
HalBuilder Core
Java
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
src
.gitignore
.travis.yml
README.md
pom.xml

README.md

Halbuilder is a simple Java API for generating and consuming HAL documents conforming to the HAL Specification.

Generating Local Resources

ResourceFactory resourceFactory = new ResourceFactory();

Resource owner = resourceFactory.newResource("http://example.com/mike")
  .withLink("td:friend", "http://example.com/mamund")
  .withProperty("name", "Mike")
  .withProperty("age", "36");

Resource halResource = resourceFactory.newResource("http://example.com/todo-list")
  .withNamespace("td", "http://example.com/todoapp/rels/")
  .withLink("td:search", "/todo-list/search;{searchterm}")
  .withLink("td:description", "/todo-list/description")
  .withProperty("created_at", "2010-01-16")
  .withProperty("updated_at", "2010-02-21")
  .withProperty("summary", "An example list")
  .withSubresource("td:owner", owner);

String xml = halResource.renderContent(ResourceFactory.HALXML);
String json = halResource.renderContent(ResourceFactory.HALJSON);

Reading Local Resources

ResourceFactory resourceFactory = new ResourceFactory();

Resource resource = resourceFactory.newResource(new InputStreamReader(Some.class.getResourceAsStream("/test.xml")));
Something went wrong with that request. Please try again.