MockFlowFile (nifi-mock 1.12.1 API)

java.lang.Object
- org.apache.nifi.util.MockFlowFile

All Implemented Interfaces:: Comparable<FlowFile>, FlowFileRecord, FlowFile

public class MockFlowFile
extends Object
implements FlowFileRecord

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.nifi.flowfile.FlowFile
  FlowFile.KeyValidator

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<String,String>`	`attributes`
`private long`	`creationTime`
`private byte[]`	`data`
`private long`	`enqueuedIndex`
`private long`	`entryDate`
`private long`	`id`
`private long`	`lastEnqueuedDate`
`private boolean`	`penalized`

Constructor Summary

Constructors
Constructor and Description

MockFlowFile(long id)

MockFlowFile(long id, FlowFile toCopy)

Constructors
Constructor and Description
`MockFlowFile(long id)`
`MockFlowFile(long id, FlowFile toCopy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assertAttributeEquals(String attributeName, String expectedValue)`
`void`	`assertAttributeExists(String attributeName)`
`void`	`assertAttributeNotEquals(String attributeName, String expectedValue)`
`void`	`assertAttributeNotExists(String attributeName)`
`void`	`assertContentEquals(byte[] data)` Asserts that the content of this FlowFile is the same as the content of the given byte array
`void`	`assertContentEquals(File file)` Asserts that the content of this FlowFile is the same as the content of the given file
`void`	`assertContentEquals(InputStream in)` Asserts that the content of this FlowFile is the same as the content of the given InputStream.
`void`	`assertContentEquals(Path path)` Asserts that the content of this FlowFile is the same as the content of the given path
`void`	`assertContentEquals(String data)`
`void`	`assertContentEquals(String data, Charset charset)`
`void`	`assertContentEquals(String data, String charset)`
`int`	`compareTo(FlowFile o)`
`boolean`	`equals(Object obj)`
`String`	`getAttribute(String attrName)`
`Map<String,String>`	`getAttributes()`
`String`	`getContent()` Returns the value of the internal content for this mock flowfile as a UTF-8 encoded String.
`ContentClaim`	`getContentClaim()`
`long`	`getContentClaimOffset()`
`InputStream`	`getContentStream()` Returns the value of the internal content for this mock flowfile as an `InputStream`.
`long`	`getCreationTime()`
`byte[]`	`getData()` Returns the value of the internal content for this mock flowfile.
`long`	`getEntryDate()`
`long`	`getId()`
`Long`	`getLastQueueDate()`
`long`	`getLineageStartDate()`
`long`	`getLineageStartIndex()`
`long`	`getPenaltyExpirationMillis()`
`long`	`getQueueDateIndex()`
`long`	`getSize()`
`int`	`hashCode()`
`boolean`	`isAttributeEqual(String attributeName, String expectedValue)`
`boolean`	`isContentEqual(byte[] expected)`
`boolean`	`isContentEqual(String expected)`
`boolean`	`isContentEqual(String expected, Charset charset)`
`boolean`	`isPenalized()`
`void`	`putAttributes(Map<String,String> attrs)`
`void`	`removeAttributes(Set<String> attrNames)`
`void`	`setData(byte[] data)` Sets the value of the internal content for this mock flowfile.
`void`	`setEnqueuedIndex(long enqueuedIndex)`
`void`	`setLastEnqueuedDate(long lastEnqueuedDate)`
`(package private) void`	`setPenalized(boolean penalized)`
`byte[]`	`toByteArray()`
`String`	`toString()`

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

- Field Detail
  - attributes
```
private final Map<String,String> attributes
```
  - id
```
private final long id
```
  - entryDate
```
private final long entryDate
```
  - creationTime
```
private final long creationTime
```
  - penalized
```
private boolean penalized
```
  - data
```
private byte[] data
```
  - lastEnqueuedDate
```
private long lastEnqueuedDate
```
  - enqueuedIndex
```
private long enqueuedIndex
```
- Constructor Detail
  - MockFlowFile
```
public MockFlowFile(long id)
```
  - MockFlowFile
```
public MockFlowFile(long id,
                    FlowFile toCopy)
```
- Method Detail
  - setPenalized
```
void setPenalized(boolean penalized)
```
  - getCreationTime
```
public long getCreationTime()
```
  - getLineageStartDate
```
public long getLineageStartDate()
```
    Specified by:
    
    getLineageStartDate in interface FlowFile
  - compareTo
```
public int compareTo(FlowFile o)
```
    Specified by:
    
    compareTo in interface Comparable<FlowFile>
  - getAttribute
```
public String getAttribute(String attrName)
```
    Specified by:
    
    getAttribute in interface FlowFile
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Specified by:
    
    getAttributes in interface FlowFile
  - getEntryDate
```
public long getEntryDate()
```
    Specified by:
    
    getEntryDate in interface FlowFile
  - getId
```
public long getId()
```
    Specified by:
    
    getId in interface FlowFile
  - getSize
```
public long getSize()
```
    Specified by:
    
    getSize in interface FlowFile
  - setData
```
public void setData(byte[] data)
```
    Sets the value of the internal content for this mock flowfile. Would not exist in standard FlowFile implementations, but useful for complex test assertions.
    
    Parameters:
    
    data - the flowfile content as a byte[]
  - getData
```
public byte[] getData()
```
    Returns the value of the internal content for this mock flowfile. Would not exist in standard FlowFile implementations, but useful for complex test assertions.
    
    Returns:
    
    the internal flowfile content as a byte[]
  - getContent
```
public String getContent()
```
    Returns the value of the internal content for this mock flowfile as a UTF-8 encoded String. Would not exist in standard FlowFile implementations, but useful for complex test assertions.
    
    Returns:
    
    the internal flowfile content as a String
  - getContentStream
```
public InputStream getContentStream()
```
    Returns the value of the internal content for this mock flowfile as an InputStream. Would not exist in standard FlowFile implementations, but useful for complex test assertions.
    
    Returns:
    
    the internal flowfile content as a stream
  - isPenalized
```
public boolean isPenalized()
```
    Specified by:
    
    isPenalized in interface FlowFile
  - putAttributes
```
public void putAttributes(Map<String,String> attrs)
```
  - removeAttributes
```
public void removeAttributes(Set<String> attrNames)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - assertAttributeExists
```
public void assertAttributeExists(String attributeName)
```
  - assertAttributeNotExists
```
public void assertAttributeNotExists(String attributeName)
```
  - assertAttributeEquals
```
public void assertAttributeEquals(String attributeName,
                                  String expectedValue)
```
  - assertAttributeNotEquals
```
public void assertAttributeNotEquals(String attributeName,
                                     String expectedValue)
```
  - assertContentEquals
```
public void assertContentEquals(File file)
                         throws IOException
```
    Asserts that the content of this FlowFile is the same as the content of the given file
    
    Parameters:
    
    file - to compare content against
    
    Throws:
    
    IOException - if fails doing IO during comparison
  - assertContentEquals
```
public void assertContentEquals(Path path)
                         throws IOException
```
    Asserts that the content of this FlowFile is the same as the content of the given path
    
    Parameters:
    
    path - where to find content to compare to
    
    Throws:
    
    IOException - if io error occurs while comparing content
  - assertContentEquals
```
public void assertContentEquals(byte[] data)
                         throws IOException
```
    Asserts that the content of this FlowFile is the same as the content of the given byte array
    
    Parameters:
    
    data - the data to compare
    
    Throws:
    
    IOException - if any ioe occurs while reading flowfile
  - assertContentEquals
```
public void assertContentEquals(String data)
```
  - assertContentEquals
```
public void assertContentEquals(String data,
                                String charset)
```
  - assertContentEquals
```
public void assertContentEquals(String data,
                                Charset charset)
```
  - assertContentEquals
```
public void assertContentEquals(InputStream in)
                         throws IOException
```
    Asserts that the content of this FlowFile is the same as the content of the given InputStream. This method closes the InputStream when it is finished.
    
    Parameters:
    
    in - the stream to source comparison data from
    
    Throws:
    
    IOException - if any issues reading from given source
  - toByteArray
```
public byte[] toByteArray()
```
    Returns:
    
    a copy of the the contents of the FlowFile as a byte array
  - getLastQueueDate
```
public Long getLastQueueDate()
```
    Specified by:
    
    getLastQueueDate in interface FlowFile
  - setLastEnqueuedDate
```
public void setLastEnqueuedDate(long lastEnqueuedDate)
```
  - getPenaltyExpirationMillis
```
public long getPenaltyExpirationMillis()
```
    Specified by:
    
    getPenaltyExpirationMillis in interface FlowFileRecord
  - getContentClaim
```
public ContentClaim getContentClaim()
```
    Specified by:
    
    getContentClaim in interface FlowFileRecord
  - getContentClaimOffset
```
public long getContentClaimOffset()
```
    Specified by:
    
    getContentClaimOffset in interface FlowFileRecord
  - getLineageStartIndex
```
public long getLineageStartIndex()
```
    Specified by:
    
    getLineageStartIndex in interface FlowFile
  - getQueueDateIndex
```
public long getQueueDateIndex()
```
    Specified by:
    
    getQueueDateIndex in interface FlowFile
  - setEnqueuedIndex
```
public void setEnqueuedIndex(long enqueuedIndex)
```
  - isAttributeEqual
```
public boolean isAttributeEqual(String attributeName,
                                String expectedValue)
```
  - isContentEqual
```
public boolean isContentEqual(String expected)
```
  - isContentEqual
```
public boolean isContentEqual(String expected,
                              Charset charset)
```
  - isContentEqual
```
public boolean isContentEqual(byte[] expected)
```

Class MockFlowFile

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.nifi.flowfile.FlowFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

attributes

id

entryDate

creationTime

penalized

data

lastEnqueuedDate

enqueuedIndex

Constructor Detail

MockFlowFile

MockFlowFile

Method Detail

setPenalized

getCreationTime

getLineageStartDate

compareTo

getAttribute

getAttributes

getEntryDate

getId

getSize

setData

getData

getContent

getContentStream

isPenalized

putAttributes

removeAttributes

toString

hashCode

equals

assertAttributeExists

assertAttributeNotExists

assertAttributeEquals

assertAttributeNotEquals

assertContentEquals

assertContentEquals

assertContentEquals

assertContentEquals

assertContentEquals

assertContentEquals

assertContentEquals

toByteArray

getLastQueueDate

setLastEnqueuedDate

getPenaltyExpirationMillis

getContentClaim

getContentClaimOffset

getLineageStartIndex

getQueueDateIndex

setEnqueuedIndex

isAttributeEqual

isContentEqual

isContentEqual

isContentEqual