sirius.kernel.di.std.Priorized Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirius-kernel Show documentation

Provides common core classes and the microkernel powering all Sirius applications

There is a newer version: 12.9.1

/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.kernel.di.std;

import sirius.kernel.commons.Explain;

/**
 * Marks a class as sortable by its priority.
 * 
 * Classes implementing this interface can be used by the {@link PriorityParts} annotation and will
 * be auto sorted (ascending) by priority before they are made available.
 */
@SuppressWarnings("squid:S1214")
@Explain("The constant is best defined here.")
public interface Priorized {

    /**
     * Contains the default priority used by Priorized parts.
     */
    int DEFAULT_PRIORITY = 100;

    /**
     * Returns the priority of this element.
     *
     * @return the priority - lower is better (comes first)
     */
    int getPriority();
}