org.nuiton.topia.persistence.TopiaEntityEnumProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

ToPIA API module

The newest version!

package org.nuiton.topia.persistence;

/*
 * #%L
 * ToPIA Extension :: API
 * %%
 * Copyright (C) 2018 - 2022 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

/**
 * Object which helps to wrap some static generated code (entityEnum).
 *
 * This contract used to be named TopiaPersistenceHelper.
 *
 * @author Tony Chemit - [email protected]
 * @since 2.6.12
 */
public interface TopiaEntityEnumProvider {

    /**
     * Method that returns the TopiaEntityEnum corresponding to the given entity's class.
     *
     * @param type the entity's class
     * @param   works only for TopiaEntity, thus E must extend TopiaEntity
     * @return the found TopiaEntityEnum. Should not be null.
     */
     T getEntityEnum(Class type);

    /**
     * Method that returns the TopiaEntityEnum corresponding to the given entity's enum name.
     *
     * @param enumName the entity's enum name
     * @return the found TopiaEntityEnum. Should not be null.
     */
    T getEntityEnum(String enumName);

}