Commit f8018678 authored by nshah's avatar nshah

OCVET-247, Applying patch to get javadoc inline with the EC, 4/11/13, 4:42pm

parent 05d89fb5
......@@ -3,8 +3,8 @@ package org.ocap.hn.transformation;
import org.ocap.hn.content.ContentFormat;
/**
* This interface represents transformations from a single input content format
* to multiple output content formats. Instances implementing this interface are
* This interface represents a transformation from an input content format
* to an output content format. Instances implementing this interface are
* created by the <code>TransformationManager</code>.
*/
public interface Transformation
......@@ -18,8 +18,8 @@ public interface Transformation
/**
* Returns the output content format the input format can
* be transformed into. For content formats, that include video the method
* SHALL return <code>OutputVideoContentFormat</code> instance.
* be transformed into. For content formats that include video the method
* SHALL return a <code>OutputVideoContentFormat</code> instance.
*
* @return The output content format.
*/
......
......@@ -99,7 +99,8 @@ 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.
* @param transformations The array of transformations to be applied. If
* null, all transformations will be removed and none will be applied.
*
* @throws IllegalArgumentException if the transformations parameter is null.
*
......@@ -136,7 +137,8 @@ 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.
* @param transformations The array of transformations to apply. If null,
* all transformations will be removed and none will be applied.
*
* @throws IllegalArgumentException if items parameter is null or empty or
* the transformations parameter is null.
......
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