FileDocCategorySizeDatePackage
AnnotatedOutput.javaAPI DocAndroid 5.1 API2711Thu Mar 12 22:18:30 GMT 2015com.android.dx.util

AnnotatedOutput

public interface AnnotatedOutput implements Output
Interface for a binary output destination that may be augmented with textual annotations.

Fields Summary
Constructors Summary
Methods Summary
public voidannotate(java.lang.String msg)
Add an annotation for the subsequent output. Any previously open annotation will be closed by this call, and the new annotation marks all subsequent output until another annotation call.

param
msg {@code non-null;} the annotation message

public voidannotate(int amt, java.lang.String msg)
Add an annotation for a specified amount of subsequent output. Any previously open annotation will be closed by this call. If there is already pending annotation from one or more previous calls to this method, the new call "consumes" output after all the output covered by the previous calls.

param
amt {@code >= 0;} the amount of output for this annotation to cover
param
msg {@code non-null;} the annotation message

public booleanannotates()
Get whether this instance will actually keep annotations.

return
{@code true} iff annotations are being kept

public voidendAnnotation()
End the most recent annotation. Subsequent output will be unannotated, until the next call to {@link #annotate}.

public intgetAnnotationWidth()
Get the maximum width of the annotated output. This is advisory: Implementations of this interface are encouraged to deal with too-wide output, but annotaters are encouraged to attempt to avoid exceeding the indicated width.

return
{@code >= 1;} the maximum width

public booleanisVerbose()
Get whether this instance is intended to keep verbose annotations. Annotators may use the result of calling this method to inform their annotation activity.

return
{@code true} iff annotations are to be verbose