Improve documentation

Make indents consistent

Author: palemieux

README.md

@@ -53,6 +53,18 @@ The following snippet illustrates the creation of an `RGBADescriptor` using the
       library/src/test/resources/imps/imp_1/VIDEO_f031aa43-88c8-4de9-856f-904a33a78505.mxf > \
       library/target/test-output/VIDEO_f031aa43-88c8-4de9-856f-904a33a78505.json
 
+## Organization
+
+The library consists of 3 modules:
+
+- `class-generator` generates POJO classes in <library/target/generated-sources> when
+  compiling the library, using the register files at <library/src/main/resources>
+- `library` holds the generated POJO classes and classes for reading and writing MXF files
+- `common` holds classes that do not depend on the generated classes
+
+_NOTE_: `common` is largely based on [regxmllib](https://github.com/sandflow/regxmllib) and
+combining the two libraries is expected in the long run.
+
 ## MXF concepts
 
 ### Data model
@@ -91,7 +103,9 @@ Index entries point to the first byte of the K of each element.
 
 In the case of clip-wrapping, the entire essence stream is wrapped into a single KLV triplet (also called an _element_).
 
-Index entries point to the first byte of the V of each element.
+Index entries are relative to the first byte of the V of each element, _with the
+exception of IAB Track Files, where they are relative to the K of the IAB Clip
+Wrap element.
 
 ### Indexing
 

common/src/main/java/com/sandflow/smpte/klv/Group.java

@@ -34,18 +34,18 @@
  */
 public interface Group {
 
-    /**
-     * Retrieves the items of the Group
-     * 
-     * @return Ordered collection of all items within the Group
-    */
-    Collection<Triplet> getItems();
+  /**
+   * Retrieves the items of the Group
+   * 
+   * @return Ordered collection of all items within the Group
+   */
+  Collection<Triplet> getItems();
 
-    /**
-     * Returns the Key of the Group
-     * 
-     * @return Key of the Group
-     */
-    UL getKey();
+  /**
+   * Returns the Key of the Group
+   * 
+   * @return Key of the Group
+   */
+  UL getKey();
 
 }

common/src/main/java/com/sandflow/smpte/klv/MemoryTriplet.java

@@ -35,40 +35,42 @@
  */
 public class MemoryTriplet implements Triplet {
 
-    final private AUID key;
-    final private byte[] value;
+  final private AUID key;
+  final private byte[] value;
 
-    /**
-     * Creates a Triplet from a Key and an array of bytes as the Value
-     * @param key Triplet Key
-     * @param value Triplet Value
-     */
-    public MemoryTriplet(AUID key, byte[] value) {
-        
-        if (key == null || value == null) throw new InvalidParameterException("Triplet muse have key and value.");
-        
-        this.key = key;
-        this.value = value;
-    }
+  /**
+   * Creates a Triplet from a Key and an array of bytes as the Value
+   * 
+   * @param key   Triplet Key
+   * @param value Triplet Value
+   */
+  public MemoryTriplet(AUID key, byte[] value) {
 
-    @Override
-    public AUID getKey() {
-        return key;
-    }
+    if (key == null || value == null)
+      throw new InvalidParameterException("Triplet muse have key and value.");
 
-    @Override
-    public long getLength() {
-        return value.length;
-    }
+    this.key = key;
+    this.value = value;
+  }
 
-    @Override
-    public byte[] getValue() {
-        return value;
-    }
+  @Override
+  public AUID getKey() {
+    return key;
+  }
+
+  @Override
+  public long getLength() {
+    return value.length;
+  }
+
+  @Override
+  public byte[] getValue() {
+    return value;
+  }
+
+  @Override
+  public InputStream getValueAsStream() {
+    return new ByteArrayInputStream(value);
+  }
 
-    @Override
-    public InputStream getValueAsStream() {
-        return new ByteArrayInputStream(value);
-    }
-    
 }

common/src/main/java/com/sandflow/smpte/klv/Triplet.java

@@ -34,28 +34,32 @@
  */
 public interface Triplet {
 
-    /**
-     * Returns the Key of the KLV Triplet
-     * @return Triplet Key
-     */
-    AUID getKey();
-    
-    /**
-     * Returns the Length of the KLV Triplet
-     * @return Triplet Length
-     */
-    long getLength();
-    
-    /**
-     * Return the Value of the KLV Triplet as a byte array
-     * @return Triplet Value
-     */
-    byte[] getValue();
-    
-    /**
-     * Return the Value of the KLV Triplet as an Input Stream
-     * @return Triplet Value
-     */ 
-    InputStream getValueAsStream();
+  /**
+   * Returns the Key of the KLV Triplet
+   * 
+   * @return Triplet Key
+   */
+  AUID getKey();
+
+  /**
+   * Returns the Length of the KLV Triplet
+   * 
+   * @return Triplet Length
+   */
+  long getLength();
+
+  /**
+   * Return the Value of the KLV Triplet as a byte array
+   * 
+   * @return Triplet Value
+   */
+  byte[] getValue();
+
+  /**
+   * Return the Value of the KLV Triplet as an Input Stream
+   * 
+   * @return Triplet Value
+   */
+  InputStream getValueAsStream();
 
 }

common/src/main/java/com/sandflow/smpte/klv/adapters/ULValueAdapter.java

@@ -1,28 +1,28 @@
 /*
- * Copyright (c) 2014, Pierre-Anthony Lemieux ([email protected])
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- */
+* Copyright (c) 2014, Pierre-Anthony Lemieux ([email protected])
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* * Redistributions of source code must retain the above copyright notice, this
+*   list of conditions and the following disclaimer.
+* * Redistributions in binary form must reproduce the above copyright notice,
+*   this list of conditions and the following disclaimer in the documentation
+*   and/or other materials provided with the distribution.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+* POSSIBILITY OF SUCH DAMAGE.
+*/
 package com.sandflow.smpte.klv.adapters;
 
 import com.sandflow.smpte.util.UL;
@@ -32,22 +32,24 @@
  */
 public class ULValueAdapter {
 
-    /**
-     * Converts a KLV Triplet Value to a UL.
-     * @param value KLV Triplet Value
-     * @return UL
-     */
-    public static UL fromValue(byte[] value) {
-        return new UL(value);
-    }
+  /**
+   * Converts a KLV Triplet Value to a UL.
+   * 
+   * @param value KLV Triplet Value
+   * @return UL
+   */
+  public static UL fromValue(byte[] value) {
+    return new UL(value);
+  }
+
+  /**
+   * Converts a UL to a KLV Triplet Value.
+   * 
+   * @param obj UL
+   * @return KLV Triplet Value
+   */
+  public static byte[] toValue(UL obj) {
+    return obj.getValue();
+  }
 
-    /**
-     * Converts a UL to a KLV Triplet Value.
-     * @param obj UL
-     * @return KLV Triplet Value
-     */
-    public static byte[] toValue(UL obj) {
-        return obj.getValue();
-    }
-    
 }

common/src/main/java/com/sandflow/smpte/klv/adapters/UMIDValueAdapter.java

@@ -32,22 +32,24 @@
  */
 public class UMIDValueAdapter {
 
-    /**
-     * Converts a KLV Triplet Value to a UMID.
-     * @param value KLV Triplet Value
-     * @return UMID
-     */
-    public static UMID fromValue(byte[] value) {
-        return new UMID(value);
-    }
+  /**
+   * Converts a KLV Triplet Value to a UMID.
+   * 
+   * @param value KLV Triplet Value
+   * @return UMID
+   */
+  public static UMID fromValue(byte[] value) {
+    return new UMID(value);
+  }
+
+  /**
+   * Converts a UMID to a KLV Triplet Value.
+   * 
+   * @param obj UMID
+   * @return KLV Triplet Value
+   */
+  public static byte[] toValue(UMID obj) {
+    return obj.getValue();
+  }
 
-    /**
-     * Converts a UMID to a KLV Triplet Value.
-     * @param obj UMID
-     * @return KLV Triplet Value
-     */
-    public static byte[] toValue(UMID obj) {
-        return obj.getValue();
-    }
-    
 }

common/src/main/java/com/sandflow/smpte/klv/adapters/UUIDValueAdapter.java

@@ -32,22 +32,24 @@
  */
 public class UUIDValueAdapter {
 
-    /**
-     * Converts a KLV Triplet Value to a UUID.
-     * @param value KLV Triplet Value
-     * @return UUID
-     */
-    public static UUID fromValue(byte[] value) {
-        return new UUID(value);
-    }
+  /**
+   * Converts a KLV Triplet Value to a UUID.
+   * 
+   * @param value KLV Triplet Value
+   * @return UUID
+   */
+  public static UUID fromValue(byte[] value) {
+    return new UUID(value);
+  }
+
+  /**
+   * Converts a UUID to a KLV Triplet Value.
+   * 
+   * @param obj UUID
+   * @return KLV Triplet Value
+   */
+  public static byte[] toValue(UUID obj) {
+    return obj.getValue();
+  }
 
-    /**
-     * Converts a UUID to a KLV Triplet Value.
-     * @param obj UUID
-     * @return KLV Triplet Value
-     */
-    public static byte[] toValue(UUID obj) {
-        return obj.getValue();
-    }
-    
 }