• Home
• com.thomsonreuters.ema
• ema
• 3.3.0.0
• source code
• RmtesBuffer.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.thomsonreuters.ema.access.RmtesBuffer Maven / Gradle / Ivy

///*|-----------------------------------------------------------------------------
// *|            This source code is provided under the Apache 2.0 license      --
// *|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
// *|                See the project's LICENSE.md for details.                  --
// *|           Copyright Thomson Reuters 2015. All rights reserved.            --
///*|-----------------------------------------------------------------------------

package com.thomsonreuters.ema.access;

import java.nio.ByteBuffer;
import java.nio.CharBuffer;

/**
 * RmtesBuffer represents RMTES data.

 * RmtesBuffer stores and applies RMTES data.
 * 
Methods {@link #asUTF8()} and {@link #asUTF16()} will trigger garbage collection.
 * 
 * 
RmtesBuffer class contains a copy of the buffer passed on apply methods.
 */
public interface RmtesBuffer
{
	/** 
	 * Returns the content converted as UTF8.
	 * 
	 * @throws OmmInvalidUsageException if fails to convert
	 * 
	 * @return ByteBuffer containing RMTES data converted to UTF8
	 */
	public ByteBuffer asUTF8();
	
	/** Returns the content converted as UTF16.
	 * 
	 * @throws OmmInvalidUsageException if fails to convert
	 * 
	 * @return CharBuffer containing RMTES data converted to UTF16
	 */
	public CharBuffer asUTF16();
	
	/**
	 * Returns a string representation of decoded RMTES data.
	 * 
	 * @throws OmmInvalidUsageException if fails to convert
	 * 
	 * @return String containing decoded RMTES data
	 */
	public String toString();
	
	/**
	 * Clears contained content.
	 * 
	 * @return reference to this object
	 */
	public RmtesBuffer clear();

	/**
	 * Apply passed in RMTES data.
	 * 
	 * @throws OmmInvalidUsageException if fails to apply
	 * 
	 * @param data specifies RmtesBuffer to be applied to this object
	 * @return reference to this object
	 */
	public RmtesBuffer apply(RmtesBuffer data);

	/**
	 * Apply passed in RMTES data.
	 * 
	 * 	@throws OmmInvalidUsageException if fails to apply
	 * 
	 * @param data specifies OmmRmtes containing RMTES data to be applied to this object
	 * @return reference to this object
	 */
	public RmtesBuffer apply(OmmRmtes data);
}