com.clxcommunications.xms.api

Class ReportType

java.lang.Object

com.clxcommunications.xms.api.ReportType

@Value.Immutable(builder=false,
                 copy=false,
                 intern=true)
public abstract class ReportType
extends Object

Describes the different types of delivery reports supported by XMS.

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	FULL A full delivery report is desired or available.
static ReportType	NONE No delivery report is desired or available.
static ReportType	PER_RECIPIENT A per recipient delivery report is desired or available.
static ReportType	SUMMARY A summary delivery report is desired or available.

Constructor Summary

Constructors

Constructor and Description
ReportType()

Method Summary

Modifier and Type	Method and Description
static ReportType	of(String type) Builds an immutable ReportType having the given literal representation.
String	toString() The string representation of this report type.
abstract String	type() The literal string representation of this report type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final ReportType NONE

No delivery report is desired or available.

SUMMARY

public static final ReportType SUMMARY

A summary delivery report is desired or available.

FULL

public static final ReportType FULL

A full delivery report is desired or available.

PER_RECIPIENT

public static final ReportType PER_RECIPIENT

A per recipient delivery report is desired or available.

Constructor Detail

ReportType

public ReportType()

Method Detail

type

public abstract String type()

The literal string representation of this report type.

Returns:

a non-null identifier

of

public static ReportType of(String type)

Builds an immutable ReportType having the given literal representation.

Parameters:

type - the report type

Returns:

a non-null report type

toString

public String toString()

The string representation of this report type.

Overrides:

toString in class Object

Returns:

a non-null string