GlyphDef.java

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.kie.workbench.common.stunner.core.definition.shape;

/**
 * Base glyph definition type.
 * @param <W> The bean type.
 */
public interface GlyphDef<W> {

    /**
     * Returns the glyph defintion type.
     */
    Class<?> getType();

    /**
     * The glyph's description. Can be used as tooltips or titles for widgets
     * or other client side components.
     */
    String getGlyphDescription(final W element);
}