callstack/org.eclipse.tracecompass.incubator.callstack.core/src/org/eclipse/tracecompass/incubator/internal/callstack/core/symbol/StringSymbol.java

/*******************************************************************************
 * Copyright (c) 2017 École Polytechnique de Montréal
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License 2.0 which
 * accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/

package org.eclipse.tracecompass.incubator.internal.callstack.core.symbol;

import java.util.Collection;
import java.util.Objects;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.tracecompass.incubator.analysis.core.concepts.ICallStackSymbol;
import org.eclipse.tracecompass.tmf.core.symbols.ISymbolProvider;

/**
 * A simple string symbol, to be used when the symbol is already available and
 * does not have to be resolved with providers
 *
 * @author Geneviève Bastien
 */
public class StringSymbol implements ICallStackSymbol {

    private final Object fSymbol;

    /**
     * Constructor
     *
     * @param symbol
     *            The string symbol
     */
    public StringSymbol(Object symbol) {
        fSymbol = symbol;
    }

    @Override
    public @NonNull String resolve(Collection<ISymbolProvider> providers) {
        return String.valueOf(fSymbol);
    }

    @Override
    public int hashCode() {
        return Objects.hash(fSymbol);
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (!(obj instanceof StringSymbol)) {
            return false;
        }
        StringSymbol other = (StringSymbol) obj;
        return (fSymbol.equals(other.fSymbol));
    }

    @Override
    public String toString() {
        return String.valueOf(fSymbol);
    }
}