tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/model/OutputElementStyle.java

/**********************************************************************
 * Copyright (c) 2019 Ericsson
 *
 * 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.tmf.core.model;

import java.util.Collections;
import java.util.Map;

import org.eclipse.jdt.annotation.Nullable;

/**
 * Output element style object for one style key. This class supports style
 * inheritance. To avoid creating new styles the element style can have a parent
 * style and will have all the same style properties values as the parent and
 * can add or override style properties.
 *
 * @author Simon Delisle
 * @since 5.2
 */
public class OutputElementStyle {

    private @Nullable String fParentStyleKey;
    private Map<String, Object> fValues;

    /**
     * Constructor. Use this constructor if the goal is to use an existing style
     * without overriding any properties.
     *
     * @param styleKey
     *            Style key.
     */
    public OutputElementStyle(String styleKey) {
        fParentStyleKey = styleKey;
        fValues = Collections.emptyMap();
    }

    /**
     * Constructor. Use this constructor to specify style values.
     *
     * @param parentStyleKey
     *            Parent style key or <code>null</code> if there is no parent.
     *            The parent key should match another style key and is used for
     *            style inheritance.
     * @param values
     *            Style values or empty map if there is no values. Use to define
     *            different style properties. Properties to use can be found in
     *            {@link StyleProperties}.
     */
    public OutputElementStyle(@Nullable String parentStyleKey, Map<String, Object> values) {
        fParentStyleKey = parentStyleKey;
        fValues = values;
    }

    /**
     * Get the parent style key.
     *
     * @return Parent key or <code>null</code> if there is no parent
     */
    public @Nullable String getParentKey() {
        return fParentStyleKey;
    }

    /**
     * Get the style values. The map keys and values are defined in
     * {@link StyleProperties}.
     *
     * @return Map of values or empty if there is no given style
     */
    public Map<String, Object> getStyleValues() {
        return fValues;
    }

    @Override
    public String toString() {
        return String.format("Style [%s, %s]", fParentStyleKey, fValues); //$NON-NLS-1$
    }
}