com.swirlds.common.constructable.ConstructableClass Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2016-2024 Hedera Hashgraph, LLC
 *
 * 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.swirlds.common.constructable;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used to annotate constructable classes. Currently, this is needed if a custom constructor type is needed instead of
 * the default {@link NoArgsConstructor}. In the future, this will replace the interface {@link RuntimeConstructable}.
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ConstructableClass {
    /**
     * The class ID for this constructable class. Should be the same value as {@link RuntimeConstructable#getClassId()}
     *
     * @return the numeric ID of this class
     */
    long value();

    /**
     * Defines what kind of constructor a {@link RuntimeConstructable} class will use. The class provided should be a
     * {@link FunctionalInterface}, meaning it should only have a single method. The return type of this method should
     * extend {@link RuntimeConstructable}. A class that uses this annotation should have a constructor that have the
     * same signature as the interface provided.
     *
     * @return an interface representing the type of constructor used
     */
    Class constructorType() default NoArgsConstructor.class;
}