org.yamcs.utils.StringConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.1
package org.yamcs.utils;

import java.math.BigInteger;
import java.nio.ByteBuffer;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

import org.yamcs.protobuf.Commanding.CommandId;
import org.yamcs.protobuf.Yamcs.AggregateValue;
import org.yamcs.protobuf.Yamcs.NamedObjectId;
import org.yamcs.protobuf.Yamcs.Value;

public class StringConverter {

    private static final BigInteger B64 = BigInteger.ZERO.setBit(64);

    public static String toString(Value rv) {
        switch (rv.getType()) {
        case BINARY:
            return byteBufferToHexString(rv.getBinaryValue().asReadOnlyByteBuffer());
        case DOUBLE:
            return Double.toString(rv.getDoubleValue());
        case FLOAT:
            return Float.toString(rv.getFloatValue());
        case SINT32:
            return Integer.toString(rv.getSint32Value());
        case UINT32:
            return Long.toString(rv.getUint32Value() & 0xFFFFFFFFL);
        case SINT64:
            return Long.toString(rv.getSint64Value());
        case UINT64:
            if (rv.getUint64Value() >= 0) {
                return Long.toString(rv.getUint64Value());
            } else {
                return BigInteger.valueOf(rv.getUint64Value()).add(B64).toString();
            }
        case STRING:
            return rv.getStringValue();
        case BOOLEAN:
            return Boolean.toString(rv.getBooleanValue());
        case TIMESTAMP:
            return TimeEncoding.toOrdinalDateTime(rv.getTimestampValue());
        case ENUMERATED:
            return rv.getStringValue();
        case ARRAY:
            return "[" + rv.getArrayValueList().stream()
                    .map(value -> toString(value))
                    .collect(Collectors.joining(", ")) + "]";
        case AGGREGATE:
            AggregateValue agg = rv.getAggregateValue();
            return "{" + IntStream.range(0, agg.getNameCount())
                    .mapToObj(i -> agg.getName(i) + ": " + toString(agg.getValue(i)))
                    .collect(Collectors.joining(", ")) + "}";
        }
        return null;
    }

    /**
     * Use {@link #toString()} instead.
     */
    @Deprecated
    public static String toString(Value rv, boolean withType) {
        return toString(rv);
    }
    
    public static String arrayToHexString(byte[] b, int offset, int length) {
        return arrayToHexString(b, offset, length, false);
    }

    public static String arrayToHexString(byte[] b, int offset, int length, boolean beautify) {
        StringBuilder sb = new StringBuilder();
        for (int i = offset; i < offset+length; i++) {
            if(beautify && (i-offset) % 32 ==0) {
                sb.append(String.format("\n0x%04X: ", (i-offset)));
            }
            sb.append(String.format("%02X", b[i] & 0xFF));
            /*String s = Integer.toString(b[i] & 0xFF, 16);
            if (s.length() == 1) {
                s = "0" + s;
            }
            sb.append(s.toUpperCase());*/
            if(beautify && (i-offset) %2 == 1) {
                sb.append(" ");
            }
        }
        return sb.toString();
    }
    
    public static String arrayToHexString(byte[] b) {
        return arrayToHexString(b, 0, b.length);
    }
    
    public static String arrayToHexString(byte[] b, boolean beautify) {
        return arrayToHexString(b, 0, b.length, beautify);
    }
    
    public static String byteBufferToHexString(ByteBuffer bb) {
        bb.mark();
        StringBuilder sb = new StringBuilder();
        int offset = 0;
        while (bb.hasRemaining()) {
            if (offset % 33 == 0) {
                sb.append("\n");
            }
            String s = Integer.toString(bb.get() & 0xFF, 16);
            offset++;
            if (s.length() == 1) {
                sb.append("0");
            }
            sb.append(s.toUpperCase());
        }
        bb.reset();
        return sb.toString();
    }

    /**
     * Convert a hex string into a byte array. If the string has an odd number of hex digits, it is padded with 0 at the
     * beginning.
     * 
     * @param s
     *            - string to be converted
     * @return binary array representation of the hex string
     */
    public static byte[] hexStringToArray(String s) {
        if ((s.length() & 1) == 1) {
            s = "0" + s;
        }
        ;
        byte[] b = new byte[s.length() >> 1];
        for (int i = 0; i < b.length; i++) {
            b[i] = (byte) (Integer.parseInt(s.substring(2 * i, 2 * i + 2), 16) & 0xFF);
        }
        return b;
    }

    /**
     * Convert a NamedObjectId to a pretty string for use in log messages etc. This gives a better formatting than the
     * default protobuf-generated toString.
     */
    public static String idToString(NamedObjectId id) {
        if (id == null) {
            return "null";
        }
        if (id.hasNamespace()) {
            return "'" + id.getName() + "' (namespace: '" + id.getNamespace() + "')";
        } else {
            return "'" + id.getName() + "' (no namespace)";
        }
    }

    /**
     * Convert a list of NamedObjectId to a pretty string for use in log messages etc. This gives a better formatting
     * than the default protobuf-generated toString.
     */
    public static String idListToString(List idList) {
        if (idList == null) {
            return "null";
        }
        StringBuilder buf = new StringBuilder("[");
        boolean first = true;
        for (NamedObjectId id : idList) {
            if (first) {
                first = false;
            } else {
                buf.append(", ");
            }
            buf.append(idToString(id));
        }
        return buf.append("]").toString();
    }

    public static String toString(CommandId cmdId) {
        return cmdId.getOrigin() + ":" + cmdId.getSequenceNumber();
    }
}