Interface MessageSplitter
-
- All Known Implementing Classes:
LineCountSplitter
,MessageCopier
,MessageSplitterImp
,MetadataDocumentCopier
,MimePartSplitter
,MultiPayloadMessageSplitter
,NoOpSplitter
,SimpleRegexpMessageSplitter
,SizeBasedSplitter
,SplitByMetadata
,StringPayloadSplitter
,XpathDocumentCopier
,XpathMessageSplitter
public interface MessageSplitter
Interface for creating multiple messages from a singleAdaptrisMessage
instance.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Iterable<AdaptrisMessage>
splitMessage(AdaptrisMessage msg)
Splits anAdaptrisMessage
into some number of AdaptrisMessage objects.
-
-
-
Method Detail
-
splitMessage
java.lang.Iterable<AdaptrisMessage> splitMessage(AdaptrisMessage msg) throws CoreException
Splits an
AdaptrisMessage
into some number of AdaptrisMessage objects. Preservation of metadata is down to the implementation.If this method returns a
CloseableIterable
, it must be closed by the caller! This contract cannot be clearly expressed in Java code without breaking the API in uncomfortable ways for things just returning a List, which is why this method is only declared to return Iterable.- Parameters:
msg
- the msg to split- Returns:
- an
Iterable
ofAdaptrisMessage
- Throws:
CoreException
- wrapping any other exception
-
-