com.refinitiv.ema.access.EmaUtility Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ema Show documentation
Enterprise Message API (EMA) Java Edition
There is a newer version: 3.8.2.0
///*|-----------------------------------------------------------------------------
// *|            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 (C) 2019 Refinitiv. All rights reserved.            --
///*|-----------------------------------------------------------------------------

package com.refinitiv.ema.access;

import java.nio.ByteBuffer;
import java.nio.charset.Charset;

/**
 * 
 * Utilities that can be used by the EMA applications.
 *
 */
public class EmaUtility
{
	/**
	 * Represent as a String all the bytes (in hex format) in a ByteBuffer.
	 * The lines of hex are appended with respective string representations.
	 * 
	 * @param buffer ByteBuffer used
	 * @return String representation of the ByteBuffer
	 */
	public static String asHexString(ByteBuffer buffer)
	{
		final int charsPerLine = 16;
        StringBuilder asString = new StringBuilder();
        StringBuilder currentLine = new StringBuilder();
        StringBuilder all = new StringBuilder();

        boolean processedFirst = false;
        int currentChar = 0;
        int length = buffer.limit();
        int	eobyte= 0;

        for (int i = buffer.position(); i < length; i++)
        {
            if (!(currentChar < charsPerLine))
            {
                all.append(currentLine.toString());
                all.append("  ");
                all.append(asString.toString());

                currentLine.setLength(0);
                asString.setLength(0);
                currentChar = 0;
            	eobyte = 0;
            }

            byte b = buffer.get(i);
            currentLine.append(eobyte%2 != 0  ? String.format("%02X ", b) : String.format("%02X", b)); 
            eobyte ^= 1;
            
            if (b > 31 && b < 127)
                asString.append((char)b);
            else
                asString.append('.');

            if (currentChar == 7)
            {
                currentLine.append(" ");
            }
            ++currentChar;
        }

        if (currentLine.length() > 0)
        {
            if (processedFirst)
            {
                all.append("\n");
                eobyte = 0;
            }
                                                         
            int fill = currentChar;
            while (fill < charsPerLine)
            {
                currentLine.append("   ");

                if (fill == 7)
                {
                    currentLine.append(" "); 
                }
                ++fill;
            }

            all.append(currentLine.toString()); 
            all.append("  ");
            all.append(asString.toString());
        }

        return all.toString();
	}

	/**
	 * Represent as a String all the bytes (in hex format) in a ByteBuffer.
	 * The lines of hex are not appended with respective string representations.
	 * 
	 * @param buffer ByteBuffer used
	 * @return String representation of the ByteBuffer as only hex
	 */
	public static String asRawHexString(ByteBuffer buffer)
	{
		final int charsPerLine = 16;
        StringBuilder currentLine = new StringBuilder();
        StringBuilder all = new StringBuilder();

        boolean processedFirst = false;
        int currentChar = 0;
        int length = buffer.limit();
        int	eobyte= 0;

        for (int i = buffer.position(); i < length; i++)
        {
            if (!(currentChar < charsPerLine))
            {
                all.append(currentLine.toString() + "\n");

                currentLine.setLength(0);
                currentChar = 0;
            	eobyte = 0;
            }

            byte b = buffer.get(i);
            currentLine.append(eobyte%2 != 0 && i != length - 1 && currentChar != charsPerLine - 1 ? String.format("%02X ", b) : String.format("%02X", b)); 
            eobyte ^= 1;
                
            ++currentChar;
        }

        if (currentLine.length() > 0)
        {
            if (processedFirst)
            {
                all.append("\n");
                eobyte = 0;
            }

            all.append(currentLine.toString());
        }

        return all.toString();
	}
	
        /**
        * Converts the underlying buffer into a String representation of the OmmBuffer.
        * This should only be called when the OmmBuffer is known to contain String data. 
        * This method creates garbage unless the underlying OmmBuffer is a String.
        * Please note, that conversion of RMTES buffer to String is not supported 
        * by this method.
        *  
        * @param ommBuffer OmmBuffer used
        * @param charset to be used to decode the OmmBuffer
        * @return String representation of the OmmBuffer
        */
	public static String asString( OmmBuffer ommBuffer, Charset charset )
	{
		if (ommBuffer != null)
		{
			ByteBuffer buffer = ommBuffer.buffer();
			byte[] bytes = new byte[ buffer.limit() ];             
			buffer.get( bytes, 0, buffer.limit() );
			return new String( bytes, charset );
		}
		return null;
	}	
	
        /**
        * Converts the underlying buffer into an ASCII String representation of the OmmBuffer.
        * This should only be called when the OmmBuffer is known to contain ASCII data. 
        * This method is using the US-ASCII for Charset.
        * This method creates garbage unless the underlying OmmBuffer is a String.
        * Please note, that conversion of RMTES buffer to String is not supported 
        * by this method.
        * 
        * @param ommBuffer OmmBuffer used
        * @return ASCII String representation of the OmmBuffer
        */
	public static String asAsciiString( OmmBuffer ommBuffer )
	{
		return asString( ommBuffer, Charset.forName( "US-ASCII" ) );
	}		
}