Commit 6e3cf1f5 authored by nshah's avatar nshah

Changed the javadoc text to reflect the EC 1815-2 version correctly

parent 3f78d296
......@@ -23,8 +23,8 @@ public interface TransformationListener extends EventListener {
public static final int REASON_RESOURCE_UNAVAILABLE = 1;
/**
* ReasonCode: The specific content item was deleted after the
* transformation was requested.
* ReasonCode: The specific content item for which the transformation was requested
* has been deleted.
*/
public static final int REASON_CONTENTITEM_DELETED = 2;
......
......@@ -36,11 +36,15 @@ public abstract class TransformationManager
* listener will be ignored.
*
* @param listener The listener that will receive the callbacks
*
* @throws IllegalArgumentException if the listener parameter is null.
*
*/
public abstract void addTransformationListener(TransformationListener listener);
/**
* Removes the specified TransformationListener.
* Removes the specified TransformationListener. If the listener specified is not
* registered or is null, then this method has no effect
*
* @param listener The listener to remove
*/
......@@ -83,6 +87,8 @@ public abstract class TransformationManager
*
* @param item The content item.
*
* @throws IllegalArgumentException if the item parameter is null.
*
* @returns The applied transformations
*/
public abstract Transformation [] getTransformations(ContentItem item);
......@@ -93,8 +99,10 @@ public abstract class TransformationManager
* any existing transformations before setting the transformations.
* See [OC-BUNDLE] for additional mapping of this method.
*
* @param transformations The array of transformations to be applied. If
* null, all transformations will be removed and none will be applied.
* @param transformations The array of transformations to be applied.
*
* @throws IllegalArgumentException if the transformations parameter is null.
*
*/
public abstract void setTransformations(Transformation [] transformations);
......@@ -119,7 +127,7 @@ public abstract class TransformationManager
* Applies specific transformations for a set of content items. Configures
* metadata indicating content transformation support that matches any
* of the transformations in the transformations array parameter for each
* content item in the content item array parameter. If a ContentItem in
* content item in the items array parameter. If a ContentItem in
* the array parameter is not local or does not represent MSO local
* content it is skipped without change or notification. A call to this
* method will remove any existing transformations before setting the
......@@ -128,10 +136,10 @@ public abstract class TransformationManager
*
* @param items The array of content items the transformation metadata will
* be configured in.
* @param transformations The array of transformations to apply. If null,
* all transformations will be removed and none will be applied.
* @param transformations The array of transformations to apply.
*
* @throws IllegalArgumentException if items parameter is null or empty.
* @throws IllegalArgumentException if items parameter is null or empty or
* the transformations parameter is null.
*/
public abstract void setTransformations(ContentItem [] items,
Transformation [] transformations);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment