Add optional data to LayoutLog API.

Change-Id: Iaa82c3647996a9ce7d7d348cdc19dce34b941238

1 files changed, 110 insertions, 10 deletions

diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/LayoutLog.java b/layoutlib_api/src/com/android/ide/common/rendering/api/LayoutLog.java
index 3a0ab06..26d0479 100644
--- a/layoutlib_api/src/com/android/ide/common/rendering/api/LayoutLog.java
+++ b/layoutlib_api/src/com/android/ide/common/rendering/api/LayoutLog.java
@@ -16,42 +16,142 @@
 
 package com.android.ide.common.rendering.api;
 
+/**
+ * Log class for actions executed through {@link Bridge} and {@link RenderSession}.
+ */
 public class LayoutLog {
+    /**
+     * Prefix for resource warnings/errors. This is not meant to be used as-is by the Layout
+     * Library, but is there to help test against a wider type of warning/error.
+     * <p/>
+     * {@code tag.startsWith(LayoutLog.TAG_RESOURCE_PREFIX} will test if the tag is any type
+     * of resource warning/error
+     */
     public final static String TAG_RESOURCES_PREFIX = "resources.";
+
+    /**
+     * Prefix for matrix warnings/errors. This is not meant to be used as-is by the Layout
+     * Library, but is there to help test against a wider type of warning/error.
+     * <p/>
+     * {@code tag.startsWith(LayoutLog.TAG_MATRIX_PREFIX} will test if the tag is any type
+     * of matrix warning/error
+     */
     public final static String TAG_MATRIX_PREFIX = "matrix.";
 
+    /**
+     * Tag for unsupported feature that can have a big impact on the rendering. For instance, aild
+     * access.
+     */
     public final static String TAG_UNSUPPORTED = "unsupported";
+
+    /**
+     * Tag for error when something really unexpected happens.
+     */
     public final static String TAG_BROKEN = "broken";
+
+    /**
+     * Tag for resource resolution failure.
+     * In this case the warning/error data object will be a ResourceValue containing the type
+     * and name of the resource that failed to resolve
+     */
     public final static String TAG_RESOURCES_RESOLVE = TAG_RESOURCES_PREFIX + "resolve";
+
+    /**
+     * Tag for failure when reading the content of a resource file.
+     */
     public final static String TAG_RESOURCES_READ = TAG_RESOURCES_PREFIX + "read";
+
+    /**
+     * Tag for wrong format in a resource value.
+     */
     public final static String TAG_RESOURCES_FORMAT = TAG_RESOURCES_PREFIX + "format";
+
+    /**
+     * Fidelity Tag used when a non affine transformation matrix is used in a Java API.
+     */
     public final static String TAG_MATRIX_AFFINE = TAG_MATRIX_PREFIX + "affine";
+
+    /**
+     * Tag used when a matrix cannot be inverted.
+     */
     public final static String TAG_MATRIX_INVERSE = TAG_MATRIX_PREFIX + "inverse";
+
+    /**
+     * Fidelity Tag used when a mask filter type is used but is not supported.
+     */
     public final static String TAG_MASKFILTER = "maskfilter";
+
+    /**
+     * Fidelity Tag used when a draw filter type is used but is not supported.
+     */
     public final static String TAG_DRAWFILTER = "drawfilter";
+
+    /**
+     * Fidelity Tag used when a path effect type is used but is not supported.
+     */
     public final static String TAG_PATHEFFECT = "patheffect";
+
+    /**
+     * Fidelity Tag used when a color filter type is used but is not supported.
+     */
     public final static String TAG_COLORFILTER = "colorfilter";
+
+    /**
+     * Fidelity Tag used when a rasterize type is used but is not supported.
+     */
     public final static String TAG_RASTERIZER = "rasterizer";
+
+    /**
+     * Fidelity Tag used when a shader type is used but is not supported.
+     */
     public final static String TAG_SHADER = "shader";
-    public final static String TAG_XFERMODE = "xfermode";
 
+    /**
+     * Fidelity Tag used when a xfermode type is used but is not supported.
+     */
+    public final static String TAG_XFERMODE = "xfermode";
 
-    public void warning(String tag, String message) {
+    /**
+     * Logs a warning.
+     * @param tag a tag describing the type of the warning
+     * @param message the message of the warning
+     * @param data an optional data bundle that the client can use to improve the warning display.
+     */
+    public void warning(String tag, String message, Object data) {
     }
 
-    public void fidelityWarning(String tag, String message, Throwable throwable) {
+    /**
+     * Logs a fidelity warning.
+     *
+     * This type of warning indicates that the render will not be
+     * the same as the rendering on a device due to limitation of the Java rendering API.
+     *
+     * @param tag a tag describing the type of the warning
+     * @param message the message of the warning
+     * @param throwable an optional Throwable that triggered the warning
+     * @param data an optional data bundle that the client can use to improve the warning display.
+     */
+    public void fidelityWarning(String tag, String message, Throwable throwable, Object data) {
     }
 
-    public void error(String tag, String message) {
+    /**
+     * Logs an error.
+     *
+     * @param tag a tag describing the type of the error
+     * @param message the message of the error
+     * @param data an optional data bundle that the client can use to improve the error display.
+     */
+    public void error(String tag, String message, Object data) {
     }
 
     /**
-     * Logs an error message and a {@link Throwable}.
-     * @param message the message to log.
-     * @param throwable the {@link Throwable} to log.
+     * Logs an error, and the {@link Throwable} that triggered it.
+     *
+     * @param tag a tag describing the type of the error
+     * @param message the message of the error
+     * @param throwable the Throwable that triggered the error
+     * @param data an optional data bundle that the client can use to improve the error display.
      */
-    public void error(String tag, String message, Throwable throwable) {
-
+    public void error(String tag, String message, Throwable throwable, Object data) {
     }
-
 }