ShapeSet.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.client;

import org.kie.workbench.common.stunner.core.client.shape.factory.ShapeFactory;

public interface ShapeSet<F extends ShapeFactory> {

    /**
     * Get the identifier for the set.
     */
    String getId();

    /**
     * Get the name for the set.
     */
    String getName();

    /**
     * Get the description for the set.
     */
    String getDescription();

    /**
     * The id of the definition set.
     */
    String getDefinitionSetId();

    /**
     * If multiple shape sets available for same definition set,
     * this indicates wheter is this shape set must be the default one.
     */
    boolean isDefault();

    /**
     * The shapes factory instance for this set.
     */
    F getShapeFactory();
}