com.io7m.jstructural.annotated

Class SAnnotator

java.lang.Object

com.io7m.jstructural.annotated.SAnnotator

public final class SAnnotator
extends Object

A document annotator.

Method Summary

Methods

Modifier and Type	Method and Description
static SADocument	document(com.io7m.jlog.Log log, SDocument d) Annotate the given document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

document

@Nonnull
public static SADocument document(@Nonnull
                          com.io7m.jlog.Log log,
                          @Nonnull
                          SDocument d)
                           throws com.io7m.jaux.Constraints.ConstraintError

Annotate the given document.

Parameters:

log - A log handle

d - The document

Returns:

An annotated document

Throws:

com.io7m.jaux.Constraints.ConstraintError - If any parameter is null