Merge pull request #93 from Netflix/feature/RestructuringAPI

Make some public classes and methods package private
Netflix · Sep 1, 2016 · 5c4fbde · 5c4fbde
2 parents 3ff36d4 + c1316bd
commit 5c4fbde
Show file tree

Hide file tree

Showing 25 changed files with 46 additions and 102 deletions.
diff --git a/...netflix/imflibrary/st2067_2/IMPAsset.java → ...java/com/netflix/imflibrary/IMPAsset.java b/...netflix/imflibrary/st2067_2/IMPAsset.java → ...java/com/netflix/imflibrary/IMPAsset.java
@@ -16,10 +16,8 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2;
+package com.netflix.imflibrary;
 
-import com.netflix.imflibrary.IMFErrorLogger;
-import com.netflix.imflibrary.IMFErrorLoggerImpl;
 import com.netflix.imflibrary.exceptions.IMFException;
 import com.netflix.imflibrary.st0429_8.PackingList;
 
@@ -37,7 +35,7 @@ public final class IMPAsset
     private final URI uri;
     private final PackingList.Asset asset;
     /**
-     * Constructor for an {@link com.netflix.imflibrary.st2067_2.IMPAsset IMPAsset} from a PackingList Asset and its URI. Construction
+     * Constructor for an {@link IMPAsset IMPAsset} from a PackingList Asset and its URI. Construction
      * fails if the URI is not absolute
      * @param uri the absolute URI
      * @param asset the corresponding asset

diff --git a/...flix/imflibrary/st2067_2/IMPDelivery.java → ...a/com/netflix/imflibrary/IMPDelivery.java b/...flix/imflibrary/st2067_2/IMPDelivery.java → ...a/com/netflix/imflibrary/IMPDelivery.java
@@ -16,10 +16,8 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2;
+package com.netflix.imflibrary;
 
-import com.netflix.imflibrary.IMFErrorLogger;
-import com.netflix.imflibrary.IMFErrorLoggerImpl;
 import com.netflix.imflibrary.st0429_8.PackingList;
 import com.netflix.imflibrary.st0429_9.AssetMap;
 import com.netflix.imflibrary.st0429_9.BasicMapProfileV2FileSet;
@@ -82,7 +80,7 @@ public IMPDelivery(BasicMapProfileV2FileSet basicMapProfileV2FileSet) throws IOE
 
     /**
      * Getter for a list of IMPs contained in this delivery
-     * @return a list of type {@link com.netflix.imflibrary.st2067_2.InteroperableMasterPackage} corresponding to IMPs
+     * @return a list of type {@link InteroperableMasterPackage} corresponding to IMPs
      * contained in this delivery
      */
     public List<InteroperableMasterPackage> getInteroperableMasterPackages()

diff --git a/.../st2067_2/InteroperableMasterPackage.java → ...mflibrary/InteroperableMasterPackage.java b/.../st2067_2/InteroperableMasterPackage.java → ...mflibrary/InteroperableMasterPackage.java
@@ -16,9 +16,8 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2;
+package com.netflix.imflibrary;
 
-import com.netflix.imflibrary.IMFErrorLogger;
 import com.netflix.imflibrary.exceptions.IMFException;
 import com.netflix.imflibrary.st0429_8.PackingList;
 
@@ -41,12 +40,12 @@ public final class InteroperableMasterPackage
 
     /**
      * Constructor for an InterOperableMasterPackage object from a {@link com.netflix.imflibrary.st0429_8.PackingList} object,
-     * the URI corresponding to the PackingList document, and a list of type {@link com.netflix.imflibrary.st2067_2.IMPAsset} that
+     * the URI corresponding to the PackingList document, and a list of type {@link IMPAsset} that
      * corresponds to assets referenced by this InteroperableMasterPackage object
      * @param packingList the corresponding packingList object
      * @param packingListURI an absolute URI for the PackingList document corresponding to the supplied PackingList object, construction
      *                       fails if the URI is not absolute
-     * @param referencedAssets the list of type {@link com.netflix.imflibrary.st2067_2.IMPAsset} corresponding to assets
+     * @param referencedAssets the list of type {@link IMPAsset} corresponding to assets
      *                         referenced by this InteroperableMasterPackage object
      */
     public InteroperableMasterPackage(PackingList packingList, URI packingListURI, List<IMPAsset> referencedAssets)

diff --git a/src/main/java/com/netflix/imflibrary/RESTfulInterfaces/IMPValidator.java b/src/main/java/com/netflix/imflibrary/RESTfulInterfaces/IMPValidator.java
@@ -66,7 +66,7 @@ public static PayloadRecord.PayloadAssetType getPayloadType(PayloadRecord payloa
         else if(PackingList.isFileOfSupportedSchema(resourceByteRangeProvider)){
             return PayloadRecord.PayloadAssetType.PackingList;
         }
-        else if(Composition.isFileOfSupportedSchema(resourceByteRangeProvider)){
+        else if(Composition.isCompositionPlaylist(resourceByteRangeProvider)){
             return PayloadRecord.PayloadAssetType.CompositionPlaylist;
         }
         return PayloadRecord.PayloadAssetType.Unknown;

diff --git a/src/main/java/com/netflix/imflibrary/st2067_2/Composition.java b/src/main/java/com/netflix/imflibrary/st2067_2/Composition.java
@@ -27,9 +27,6 @@
 import com.netflix.imflibrary.RESTfulInterfaces.PayloadRecord;
 import com.netflix.imflibrary.exceptions.IMFException;
 import com.netflix.imflibrary.exceptions.MXFException;
-import com.netflix.imflibrary.st2067_2.CompositionModels.*;
-import com.netflix.imflibrary.st2067_2.CompositionModels.st2067_2_2013.CompositionModel_st2067_2_2013;
-import com.netflix.imflibrary.st2067_2.CompositionModels.st2067_2_2016.CompositionModel_st2067_2_2016;
 import com.netflix.imflibrary.utils.DOMNodeObjectModel;
 import com.netflix.imflibrary.st0377.HeaderPartition;
 import com.netflix.imflibrary.st0377.PrimerPack;
@@ -49,7 +46,6 @@
 import com.sandflow.smpte.klv.Triplet;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.smpte_ra.schemas.st2067_2_2013.TrackFileResourceType;
 import org.w3c.dom.Document;
 import org.w3c.dom.DocumentFragment;
 import org.w3c.dom.Node;
@@ -434,37 +430,6 @@ private final String serializeIMFCoreConstaintsSchemasToString(List<CoreConstrai
         return stringBuilder.toString();
     }
 
-    /**
-     * A stateless method that verifies if the raw data represented by the ResourceByteRangeProvider corresponds to a valid
-     * IMF Composition Playlist document
-     *
-     * @param resourceByteRangeProvider - a byte range provider for the document that needs to be verified
-     * @return - a boolean indicating if the document represented is an IMF Composition or not
-     * @throws IOException - any I/O related error is exposed through an IOException
-     */
-    public static boolean isFileOfSupportedSchema(ResourceByteRangeProvider resourceByteRangeProvider) throws IOException {
-
-        try (InputStream inputStream = resourceByteRangeProvider.getByteRangeAsStream(0, resourceByteRangeProvider.getResourceSize() - 1);) {
-            DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
-            documentBuilderFactory.setNamespaceAware(true);
-            DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
-            Document document = documentBuilder.parse(inputStream);
-            NodeList nodeList = null;
-            for (String supportedSchemaURI : supportedCPLSchemaURIs) {
-                //obtain root node
-                nodeList = document.getElementsByTagNameNS(supportedSchemaURI, "CompositionPlaylist");
-                if (nodeList != null
-                        && nodeList.getLength() == 1) {
-                    return true;
-                }
-            }
-        } catch (ParserConfigurationException | SAXException e) {
-            return false;
-        }
-
-        return false;
-    }
-
     /**
      * A method that returns a string representation of a Composition object
      *
@@ -576,7 +541,7 @@ String getContentTitle() {
      *
      * @return {@link java.util.Map Map}&lt;{@link java.util.UUID UUID},{@link Composition.VirtualTrack VirtualTrack}&gt;. The UUID key corresponds to VirtualTrackID
      */
-    public Map<UUID, ? extends VirtualTrack> getVirtualTrackMap() {
+    Map<UUID, ? extends VirtualTrack> getVirtualTrackMap() {
         return Collections.unmodifiableMap(this.virtualTrackMap);
     }
 
@@ -1111,14 +1076,25 @@ public List<? extends Composition.VirtualTrack> getVirtualTracks() {
         return new ArrayList<>(virtualTrackMap.values());
     }
 
+    /**
+     * A utility method to retrieve the EssenceDescriptors within a Composition.
+     *
+     * @return A list of EssenceDescriptors in the Composition.
+     */
+    @Nonnull
+    public List<DOMNodeObjectModel> getEssenceDescriptors() {
+        Map<UUID, DOMNodeObjectModel> essenceDescriptorMap = this.getEssenceDescriptorListMap();
+        return new ArrayList<>(essenceDescriptorMap.values());
+    }
+
     /**
      * A utility method to retrieve the UUIDs of the Track files referenced by a Virtual track within a Composition.
      *
      * @param virtualTrack - object model of an IMF virtual track {@link Composition.VirtualTrack}
      * @return A list of TrackFileResourceType objects corresponding to the virtual track in the Composition.
      */
     @Nonnull
-    public List<ResourceIdTuple> getVirtualTrackResourceIDs(@Nonnull Composition.VirtualTrack virtualTrack) {
+    public static List<ResourceIdTuple> getVirtualTrackResourceIDs(@Nonnull Composition.VirtualTrack virtualTrack) {
 
         List<ResourceIdTuple> virtualTrackResourceIDs = new ArrayList<>();
 
@@ -1138,13 +1114,14 @@ public List<ResourceIdTuple> getVirtualTrackResourceIDs(@Nonnull Composition.Vir
         return Collections.unmodifiableList(virtualTrackResourceIDs);
     }
 
+
     /**
      * A utility method that will analyze the EssenceDescriptorList in a Composition and construct a HashMap mapping
      * a UUID to a EssenceDescriptor.
      *
      * @return a HashMap mapping the UUID to its corresponding EssenceDescriptor in the Composition
      */
-    public Map<UUID, DOMNodeObjectModel> getEssenceDescriptorListMap() {
+    Map<UUID, DOMNodeObjectModel> getEssenceDescriptorListMap() {
         IMFErrorLogger imfErrorLogger = new IMFErrorLoggerImpl();
         Map<UUID, DOMNodeObjectModel> essenceDescriptorMap = new HashMap<>();
         if (compositionPlaylistType.getEssenceDescriptorList() != null) {

diff --git a/..._2013/CompositionModel_st2067_2_2013.java → ...067_2/CompositionModel_st2067_2_2013.java b/..._2013/CompositionModel_st2067_2_2013.java → ...067_2/CompositionModel_st2067_2_2013.java
@@ -1,9 +1,8 @@
-package com.netflix.imflibrary.st2067_2.CompositionModels.st2067_2_2013;
+package com.netflix.imflibrary.st2067_2;
 
 import com.netflix.imflibrary.IMFErrorLogger;
 import com.netflix.imflibrary.exceptions.IMFException;
 import com.netflix.imflibrary.st2067_2.*;
-import com.netflix.imflibrary.st2067_2.CompositionModels.*;
 import com.netflix.imflibrary.utils.UUIDHelper;
 import com.netflix.imflibrary.writerTools.CompositionPlaylistBuilder_2013;
 import org.w3c.dom.Element;
@@ -20,7 +19,7 @@
 /**
  * A class that models aspects of a Composition such as a VirtualTrack, TrackResources etc. compliant with the 2013 CompositionPlaylist specification st2067-3:2013.
  */
-public final class CompositionModel_st2067_2_2013 {
+final class CompositionModel_st2067_2_2013 {
 
     //To prevent instantiation
     private CompositionModel_st2067_2_2013(){

diff --git a/..._2016/CompositionModel_st2067_2_2016.java → ...067_2/CompositionModel_st2067_2_2016.java b/..._2016/CompositionModel_st2067_2_2016.java → ...067_2/CompositionModel_st2067_2_2016.java
@@ -1,9 +1,8 @@
-package com.netflix.imflibrary.st2067_2.CompositionModels.st2067_2_2016;
+package com.netflix.imflibrary.st2067_2;
 
 import com.netflix.imflibrary.IMFErrorLogger;
 import com.netflix.imflibrary.exceptions.IMFException;
 import com.netflix.imflibrary.st2067_2.*;
-import com.netflix.imflibrary.st2067_2.CompositionModels.*;
 import com.netflix.imflibrary.utils.UUIDHelper;
 import com.netflix.imflibrary.writerTools.CompositionPlaylistBuilder_2016;
 import org.w3c.dom.Element;
@@ -20,7 +19,7 @@
 /**
  * A class that models aspects of a Composition such as a VirtualTrack, TrackResources etc. compliant with the 2016 CompositionPlaylist specification st2067-3:2016.
  */
-public final class CompositionModel_st2067_2_2016 {
+final class CompositionModel_st2067_2_2016 {
 
     //To prevent instantiation
     private CompositionModel_st2067_2_2016(){

diff --git a/...ompositionModels/IMFBaseResourceType.java → ...library/st2067_2/IMFBaseResourceType.java b/...ompositionModels/IMFBaseResourceType.java → ...library/st2067_2/IMFBaseResourceType.java
@@ -16,11 +16,10 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import com.netflix.imflibrary.IMFErrorLoggerImpl;
 import com.netflix.imflibrary.exceptions.IMFException;
-import com.netflix.imflibrary.st2067_2.Composition;
 
 import java.math.BigInteger;
 import java.util.List;

diff --git a/...ionModels/IMFCompositionPlaylistType.java → .../st2067_2/IMFCompositionPlaylistType.java b/...ionModels/IMFCompositionPlaylistType.java → .../st2067_2/IMFCompositionPlaylistType.java
@@ -16,12 +16,11 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import com.netflix.imflibrary.IMFErrorLogger;
 import com.netflix.imflibrary.IMFErrorLoggerImpl;
 import com.netflix.imflibrary.exceptions.IMFException;
-import com.netflix.imflibrary.st2067_2.Composition;
 import com.netflix.imflibrary.utils.UUIDHelper;
 
 import javax.annotation.concurrent.Immutable;
@@ -32,7 +31,7 @@
  * A class that models an IMF Composition Playlist structure.
  */
 @Immutable
-public final class IMFCompositionPlaylistType {
+final class IMFCompositionPlaylistType {
     private final UUID id;
     private final Composition.EditRate editRate;
     private final String annotation;

diff --git a/src/main/java/com/netflix/imflibrary/st2067_2/IMFCoreConstraintsChecker.java b/src/main/java/com/netflix/imflibrary/st2067_2/IMFCoreConstraintsChecker.java
@@ -2,12 +2,8 @@
 
 import com.netflix.imflibrary.IMFErrorLogger;
 import com.netflix.imflibrary.IMFErrorLoggerImpl;
-import com.netflix.imflibrary.exceptions.IMFException;
-import com.netflix.imflibrary.st2067_2.CompositionModels.*;
 import com.netflix.imflibrary.utils.UUIDHelper;
-import org.smpte_ra.schemas.st2067_2_2016.MarkerResourceType;
 
-import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.util.HashSet;
 import java.util.Iterator;
@@ -19,7 +15,7 @@
 /**
  * A class that performs 2013 CoreConstraints st2067-2:2013 related checks on the elements of a Composition Playlist such as VirtualTracks, Segments, Sequences and Resources.
  */
-public final class IMFCoreConstraintsChecker {
+final class IMFCoreConstraintsChecker {
 
 
     //To prevent instantiation

diff --git a/src/main/java/com/netflix/imflibrary/st2067_2/IMFEssenceComponentVirtualTrack.java b/src/main/java/com/netflix/imflibrary/st2067_2/IMFEssenceComponentVirtualTrack.java
@@ -18,9 +18,6 @@
 
 package com.netflix.imflibrary.st2067_2;
 
-import com.netflix.imflibrary.st2067_2.CompositionModels.IMFBaseResourceType;
-import com.netflix.imflibrary.st2067_2.CompositionModels.IMFMarkerResourceType;
-import com.netflix.imflibrary.st2067_2.CompositionModels.IMFTrackFileResourceType;
 import com.netflix.imflibrary.utils.UUIDHelper;
 
 import javax.annotation.concurrent.Immutable;

diff --git a/...nModels/IMFEssenceDescriptorBaseType.java → ...t2067_2/IMFEssenceDescriptorBaseType.java b/...nModels/IMFEssenceDescriptorBaseType.java → ...t2067_2/IMFEssenceDescriptorBaseType.java
@@ -16,7 +16,7 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import com.netflix.imflibrary.utils.UUIDHelper;
 
@@ -29,7 +29,7 @@
  * A class that models a Composition's Essence Descriptor.
  */
 @Immutable
-public final class IMFEssenceDescriptorBaseType {
+final class IMFEssenceDescriptorBaseType {
     protected final UUID id;
     protected final List<Object> any;
 

diff --git a/...positionModels/IMFMarkerResourceType.java → ...brary/st2067_2/IMFMarkerResourceType.java b/...positionModels/IMFMarkerResourceType.java → ...brary/st2067_2/IMFMarkerResourceType.java
@@ -16,7 +16,7 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import javax.annotation.concurrent.Immutable;
 import java.math.BigInteger;

diff --git a/...67_2/CompositionModels/IMFMarkerType.java → ...ix/imflibrary/st2067_2/IMFMarkerType.java b/...67_2/CompositionModels/IMFMarkerType.java → ...ix/imflibrary/st2067_2/IMFMarkerType.java
@@ -16,7 +16,7 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import javax.annotation.concurrent.Immutable;
 import java.math.BigInteger;

diff --git a/src/main/java/com/netflix/imflibrary/st2067_2/IMFMarkerVirtualTrack.java b/src/main/java/com/netflix/imflibrary/st2067_2/IMFMarkerVirtualTrack.java
@@ -18,12 +18,7 @@
 
 package com.netflix.imflibrary.st2067_2;
 
-import com.netflix.imflibrary.st2067_2.CompositionModels.IMFBaseResourceType;
-import com.netflix.imflibrary.st2067_2.CompositionModels.IMFMarkerResourceType;
-import org.smpte_ra.schemas.st2067_2_2013.BaseResourceType;
-
 import javax.annotation.concurrent.Immutable;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.UUID;
 

diff --git a/...7_2/CompositionModels/IMFSegmentType.java → ...x/imflibrary/st2067_2/IMFSegmentType.java b/...7_2/CompositionModels/IMFSegmentType.java → ...x/imflibrary/st2067_2/IMFSegmentType.java
@@ -16,7 +16,7 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import javax.annotation.concurrent.Immutable;
 import java.util.List;
@@ -25,7 +25,7 @@
  * A class that models Segment structure of an IMF Composition Playlist.
  */
 @Immutable
-public final class IMFSegmentType {
+final class IMFSegmentType {
     protected final String id;
     protected final List<IMFSequenceType> sequenceList;
 

diff --git a/..._2/CompositionModels/IMFSequenceType.java → .../imflibrary/st2067_2/IMFSequenceType.java b/..._2/CompositionModels/IMFSequenceType.java → .../imflibrary/st2067_2/IMFSequenceType.java
@@ -16,9 +16,7 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
-
-import com.netflix.imflibrary.st2067_2.Composition;
+package com.netflix.imflibrary.st2067_2;
 
 import javax.annotation.concurrent.Immutable;
 import java.util.List;
@@ -27,7 +25,7 @@
  * A class that models Sequence structure of an IMF Composition Playlist.
  */
 @Immutable
-public final class IMFSequenceType {
+final class IMFSequenceType {
     protected final String id;
     protected final String trackId;
     protected final List<? extends IMFBaseResourceType> resourceList;

diff --git a/...itionModels/IMFTrackFileResourceType.java → ...ry/st2067_2/IMFTrackFileResourceType.java b/...itionModels/IMFTrackFileResourceType.java → ...ry/st2067_2/IMFTrackFileResourceType.java
@@ -16,7 +16,7 @@
  *
  */
 
-package com.netflix.imflibrary.st2067_2.CompositionModels;
+package com.netflix.imflibrary.st2067_2;
 
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;