io.deephaven.engine.table.impl.preview.DisplayWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-table Show documentation

Engine Table: Implementation and closely-coupled utilities

There is a newer version: 0.37.1

Show newest version

/**
 * Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
 */
package io.deephaven.engine.table.impl.preview;

import io.deephaven.configuration.Configuration;
import org.jetbrains.annotations.Nullable;

import java.io.Serializable;

/**
 * Wraps Objects that cannot be displayed (e.g. not serializable or an unknown class) and allows them to be displayed as
 * a String.
 */
public class DisplayWrapper implements Serializable {
    private static final int MAX_CHARACTERS =
            Configuration.getInstance().getIntegerWithDefault("DisplayWrapper.maxCharacters", 10000);
    private final String displayString;

    /**
     * Creates a new DisplayWrapper around an Object. Returns null if the Object is null.
     *
     * @param objectToWrap the Object to wrap
     * @return a new DisplayWrapper, null if the Object is null
     */
    @Nullable
    public static DisplayWrapper make(Object objectToWrap) {
        if (objectToWrap == null) {
            return null;
        } else {
            return new DisplayWrapper(objectToWrap);
        }
    }

    private DisplayWrapper(Object objectToWrap) {
        final String s = objectToWrap.toString();
        displayString = s.substring(0, Math.min(s.length(), MAX_CHARACTERS));
    }

    @Override
    public String toString() {
        return displayString;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof DisplayWrapper) {
            return displayString.equals(((DisplayWrapper) obj).displayString);
        }

        return false;
    }
}