sirius.db.mixing.Nested Maven / Gradle / Ivy

Go to download

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

Provides a modern and highly flexible ORM and lightweight connectivity for JDBC, MongoDB, Redis, Elasticsearch.

There is a newer version: 7.4

/*
 * 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.db.mixing;

import sirius.kernel.di.std.Part;
import sirius.kernel.health.Exceptions;

import java.util.Objects;

/**
 * Base class for all nested objects.
 * 
 * A nested object can be placed in a {@link sirius.db.mixing.types.NestedList} or
 * {@link sirius.db.mixing.types.StringNestedMap} if the {@link BaseMapper mapper} supports it.
 * 

 * Do not use this to embed a single object in an entity as a {@link Composite} can be used for that. This
 * will automatically unfold all properties along with consistency checks.
 * 

 * As it derives from {@link Mixable} a nested object can be extended using Mixins.
 */
public class Nested extends Mixable {

    @Part
    private static Mixing mixing;

    /**
     * Creates a copy of this object.
     * 
     * Note that this will only copy known {@link Property properties} and skip transient ones.
     *
     * @return a copy of this object
     */
    public Nested copy() {
        try {
            EntityDescriptor descriptor = mixing.getDescriptor(getClass());

            Nested copy = getClass().getDeclaredConstructor().newInstance();

            for (Property property : descriptor.getProperties()) {
                property.setValue(copy, property.getValueAsCopy(this));
            }

            return copy;
        } catch (Exception e) {
            throw Exceptions.handle(Mixing.LOG, e);
        }
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }

        if (obj == this) {
            return true;
        }

        if (!getClass().isInstance(obj)) {
            return false;
        }

        EntityDescriptor descriptor = mixing.getDescriptor(getClass());
        for (Property property : descriptor.getProperties()) {
            if (!Objects.equals(property.getValue(this), property.getValue(obj))) {
                return false;
            }
        }

        return true;
    }

    @Override
    public int hashCode() {
        int result = 1;

        EntityDescriptor descriptor = mixing.getDescriptor(getClass());
        for (Property property : descriptor.getProperties()) {
            Object element = property.getValue(this);
            result = 31 * result + (element == null ? 0 : element.hashCode());
        }

        return result;
    }
}