PartitionPack

java.lang.Object
- com.netflix.imflibrary.st0377.PartitionPack

@Immutable
public final class PartitionPack
extends java.lang.Object

Object model corresponding to a PartitionPack defined in st377-1:2011

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PartitionPack.PartitionPackType` An enum to represent the PartitionPackTypes which can be extended only by the PartitionPack class

Constructor Summary

Constructors
Constructor and Description
`PartitionPack(ByteProvider byteProvider)` Instantiates a new Partition pack.
`PartitionPack(ByteProvider byteProvider, java.lang.Long byteOffset, boolean checkForSucceedingKLVFillItem)` Instantiates a new Partition pack.
`PartitionPack(ByteProvider byteProvider, java.lang.Long byteOffset, boolean checkForSucceedingKLVFillItem, IMFErrorLogger imfErrorLogger)` Instantiates a new Partition pack.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getBodySID()` Getter for identifier of the Essence container segment found in this partition.
`long`	`getEssenceStreamSegmentStartStreamPosition()` Gets essence stream segment start stream position.
`long`	`getHeaderByteCount()` Getter for the header byte count that represents the count of bytes used for HeaderMetadata and Primer pack.
`long`	`getIndexByteCount()` Getter for count of bytes used for IndexTable segments.
`long`	`getIndexSID()` Getter for the index table segment identifier in this partition.
`long`	`getKLVPacketSize()` Getter for the KLV packet size.
`int`	`getNumberOfEssenceContainerULs()` Getter for the number of essence container ULs that are referred by this partition pack
`byte[]`	`getOperationalPattern()` Getter for the operational pattern that this MXF file complies to
`long`	`getPartitionByteOffset()` Getter for this partition's byte offset.
`long`	`getPartitionDataByteOffset()` Getter for the partition data byte offset.
`PartitionPack.PartitionPackType`	`getPartitionPackType()` Partition pack type of this pack.
`long`	`getSize()` Getter for the size field of a KLV packet.
`long`	`getVSize()` Getter for the size of the value field of a KLV packet.
`boolean`	`hasEssenceContainer()` Checks if this partition has essence container data.
`boolean`	`hasHeaderMetadata()` Checks if this partition pack has header metadata.
`boolean`	`hasIndexTableSegments()` Checks if this partition has index table segments.
`boolean`	`isBodyPartition()` Checks if this is a body partition.
`boolean`	`isFooterPartition()` Checks of this is a footer partition.
`boolean`	`isGenericStreamPartition()` Checks if this is a Generic Stream partition.
`boolean`	`isHeaderPartition()` Checks if this is a header partition.
`boolean`	`isValidFooterPartition()` Checks if this is a valid footer partition.
`boolean`	`isValidHeaderPartition()` Checks if this is a valid header partition.
`boolean`	`nextHeaderWasRead()` Checks if the next header was read.
`boolean`	`nextPacketIsKLVFillItem()` Checks if the next packet is a KLV fill item.
`java.lang.String`	`toString()` A method that returns a string representation of a PartitionPack object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PartitionPack
```
public PartitionPack(ByteProvider byteProvider)
              throws java.io.IOException
```
    Instantiates a new Partition pack.
    
    Parameters:
    
    byteProvider - the mxf byte provider
    
    Throws:
    
    java.io.IOException - the iO exception
  - PartitionPack
```
public PartitionPack(ByteProvider byteProvider,
                     java.lang.Long byteOffset,
                     boolean checkForSucceedingKLVFillItem)
              throws java.io.IOException
```
    Instantiates a new Partition pack.
    
    Parameters:
    
    byteProvider - the mxf byte provider
    
    byteOffset - the byteOffset from the HeaderPartition of this partition pack
    
    checkForSucceedingKLVFillItem - the check for succeeding kLV fill item
    
    Throws:
    
    java.io.IOException - - any I/O related error will be exposed through an IOException
  - PartitionPack
```
public PartitionPack(ByteProvider byteProvider,
                     java.lang.Long byteOffset,
                     boolean checkForSucceedingKLVFillItem,
                     @Nullable
                     IMFErrorLogger imfErrorLogger)
              throws java.io.IOException
```
    Instantiates a new Partition pack.
    
    Parameters:
    
    byteProvider - the mxf byte provider
    
    byteOffset - the byteOffset from the HeaderPartition of this partition pack
    
    checkForSucceedingKLVFillItem - the check for succeeding kLV fill item
    
    imfErrorLogger - the imf error logger
    
    Throws:
    
    java.io.IOException - - any I/O related error will be exposed through an IOException
- Method Detail
  - getOperationalPattern
```
public byte[] getOperationalPattern()
```
    Getter for the operational pattern that this MXF file complies to
    
    Returns:
    
    the byte [ ]
  - getNumberOfEssenceContainerULs
```
public int getNumberOfEssenceContainerULs()
```
    Getter for the number of essence container ULs that are referred by this partition pack
    
    Returns:
    
    the number of essence container ULs that are referred by this partition pack
  - getPartitionPackType
```
public PartitionPack.PartitionPackType getPartitionPackType()
```
    Partition pack type of this pack.
    
    Returns:
    
    PartitionPackType
  - isHeaderPartition
```
public boolean isHeaderPartition()
```
    Checks if this is a header partition.
    
    Returns:
    
    the boolean
  - isValidHeaderPartition
```
public boolean isValidHeaderPartition()
```
    Checks if this is a valid header partition.
    
    Returns:
    
    the boolean
  - isBodyPartition
```
public boolean isBodyPartition()
```
    Checks if this is a body partition.
    
    Returns:
    
    the boolean
  - isFooterPartition
```
public boolean isFooterPartition()
```
    Checks of this is a footer partition.
    
    Returns:
    
    the boolean
  - isValidFooterPartition
```
public boolean isValidFooterPartition()
```
    Checks if this is a valid footer partition.
    
    Returns:
    
    the boolean
  - isGenericStreamPartition
```
public boolean isGenericStreamPartition()
```
    Checks if this is a Generic Stream partition.
    
    Returns:
    
    the boolean
  - getHeaderByteCount
```
public long getHeaderByteCount()
```
    Getter for the header byte count that represents the count of bytes used for HeaderMetadata and Primer pack.
    
    Returns:
    
    the header byte count
  - hasHeaderMetadata
```
public boolean hasHeaderMetadata()
```
    Checks if this partition pack has header metadata.
    
    Returns:
    
    the boolean
  - getIndexByteCount
```
public long getIndexByteCount()
```
    Getter for count of bytes used for IndexTable segments.
    
    Returns:
    
    the index byte count
  - getIndexSID
```
public long getIndexSID()
```
    Getter for the index table segment identifier in this partition.
    
    Returns:
    
    the index sID
  - hasIndexTableSegments
```
public boolean hasIndexTableSegments()
```
    Checks if this partition has index table segments.
    
    Returns:
    
    the boolean
  - getBodySID
```
public long getBodySID()
```
    Getter for identifier of the Essence container segment found in this partition.
    
    Returns:
    
    the body sID
  - hasEssenceContainer
```
public boolean hasEssenceContainer()
```
    Checks if this partition has essence container data.
    
    Returns:
    
    the boolean
  - getKLVPacketSize
```
public long getKLVPacketSize()
```
    Getter for the KLV packet size.
    
    Returns:
    
    the KLV packet size
  - getVSize
```
public long getVSize()
```
    Getter for the size of the value field of a KLV packet.
    
    Returns:
    
    the value size
  - getSize
```
public long getSize()
```
    Getter for the size field of a KLV packet.
    
    Returns:
    
    the size
  - getPartitionByteOffset
```
public long getPartitionByteOffset()
```
    Getter for this partition's byte offset.
    
    Returns:
    
    the partition byte offset
  - getEssenceStreamSegmentStartStreamPosition
```
public long getEssenceStreamSegmentStartStreamPosition()
                                                throws MXFException
```
    Gets essence stream segment start stream position.
    
    Returns:
    
    byte offset of the start of the essence segment, relative to the start of the essence stream
    
    Throws:
    
    MXFException - if the partition does not contain essence
  - nextHeaderWasRead
```
public boolean nextHeaderWasRead()
```
    Checks if the next header was read.
    
    Returns:
    
    the boolean
  - nextPacketIsKLVFillItem
```
public boolean nextPacketIsKLVFillItem()
```
    Checks if the next packet is a KLV fill item.
    
    Returns:
    
    the boolean
  - getPartitionDataByteOffset
```
public long getPartitionDataByteOffset()
```
    Getter for the partition data byte offset.
    
    Returns:
    
    the partition data byte offset
  - toString
```
public java.lang.String toString()
```
    A method that returns a string representation of a PartitionPack object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representing the object

Class PartitionPack

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartitionPack

PartitionPack

PartitionPack

Method Detail

getOperationalPattern

getNumberOfEssenceContainerULs

getPartitionPackType

isHeaderPartition

isValidHeaderPartition

isBodyPartition

isFooterPartition

isValidFooterPartition

isGenericStreamPartition

getHeaderByteCount

hasHeaderMetadata

getIndexByteCount

getIndexSID

hasIndexTableSegments

getBodySID

hasEssenceContainer

getKLVPacketSize

getVSize

getSize

getPartitionByteOffset

getEssenceStreamSegmentStartStreamPosition

nextHeaderWasRead

nextPacketIsKLVFillItem

getPartitionDataByteOffset

toString