com.landawn.abacus.util.EntityId Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of abacus-common Show documentation
A general programming library in Java/Android. It's easy to learn and simple to use with concise and powerful APIs.
There is a newer version: 5.2.4
/*
 * Copyright (C) 2015 HaiYang Li
 *
 * 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 com.landawn.abacus.util;

import java.util.Collection;
import java.util.Map;
import java.util.Set;

/**
 * Identity of an entity.
 *
 * @author Haiyang Li
 * @since 0.8
 */
public interface EntityId {

    /**
     *
     * @param propName property name with entity name, for example {@code Account.id}
     * @param propValue
     * @return
     */
    static EntityId of(String propName, Object propValue) {
        return Seid.of(propName, propValue);
    }

    /**
     *
     * @param entityName
     * @param propName
     * @param propValue
     * @return
     */
    @SuppressWarnings("deprecation")
    static EntityId of(String entityName, String propName, Object propValue) {
        return Seid.of(entityName).set(propName, propValue);
    }

    /**
     *
     * @param propName1 property name with entity name, for example {@code Account.id}
     * @param propValue1
     * @param propName2
     * @param propValue2
     * @return
     */
    static EntityId of(String propName1, Object propValue1, String propName2, Object propValue2) {
        return Seid.of(propName1, propValue1, propName2, propValue2);
    }

    /**
     *
     * @param entityName
     * @param propName1
     * @param propValue1
     * @param propName2
     * @param propValue2
     * @return
     */
    @SuppressWarnings("deprecation")
    static EntityId of(String entityName, String propName1, Object propValue1, String propName2, Object propValue2) {
        return Seid.of(entityName).set(propName1, propValue1).set(propName2, propValue2);
    }

    /**
     *
     * @param propName1 property name with entity name, for example {@code Account.id}
     * @param propValue1
     * @param propName2
     * @param propValue2
     * @param propName3
     * @param propValue3
     * @return
     */
    static EntityId of(String propName1, Object propValue1, String propName2, Object propValue2, String propName3, Object propValue3) {
        return Seid.of(propName1, propValue1, propName2, propValue2, propName3, propValue3);
    }

    /**
     *
     * @param entityName
     * @param propName1
     * @param propValue1
     * @param propName2
     * @param propValue2
     * @param propName3
     * @param propValue3
     * @return
     */
    @SuppressWarnings("deprecation")
    static EntityId of(String entityName, String propName1, Object propValue1, String propName2, Object propValue2, String propName3, Object propValue3) {
        return Seid.of(entityName).set(propName1, propValue1).set(propName2, propValue2).set(propName3, propValue3);
    }

    /**
     *
     * @param nameValues
     * @return
     */
    static EntityId from(Map nameValues) {
        return Seid.from(nameValues);
    }

    /**
     *
     * @param entityName
     * @param nameValues
     * @return
     */
    @SuppressWarnings("deprecation")
    static EntityId from(String entityName, Map nameValues) {
        final Seid seid = Seid.of(entityName);
        seid.set(nameValues);
        return seid;
    }

    /**
     *
     * @param entity
     * @return
     */
    static EntityId from(Object entity) {
        return Seid.from(entity);
    }

    /**
     *
     * @param entity
     * @param idPropNames
     * @return
     */
    static EntityId from(Object entity, Collection idPropNames) {
        return Seid.from(entity, idPropNames);
    }

    /**
     *
     * @return String
     */
    String entityName();

    /**
     *
     * @param 
     * @param propName
     * @return T
     */
     T get(String propName);

    /**
     *
     * @param propName
     * @return
     */
    int getInt(String propName);

    /**
     *
     * @param propName
     * @return
     */
    long getLong(String propName);

    /**
     * 

     * Node: To follow one of general design rules in {@code Abacus}, if there is a conversion behind when the source value is not assignable to the target type, put the {@code targetType} to last parameter of the method.
     * Otherwise, put the {@code targetTpye} to the first parameter of the method.
     *
     * @param  
     * @param propName 
     * @param targetType 
     * @return T
     */
     T get(String propName, Class targetType);

    /**
     *
     * @param propName
     * @return
     */
    boolean containsKey(String propName);

    /**
     *
     * @return Set
     */
    Set keySet();

    /**
     * 
     *
     * @return 
     */
    Set> entrySet();

    /**
     * 
     *
     * @return 
     */
    int size();

    /**
     * 
     *
     * @return 
     */
    boolean isEmpty();
}