io.devbench.uibuilder.annotations.ControllerBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of uibuilder-spring Show documentation

Spring support for the UIBuilder Framework

The newest version!

/*
 *
 * Copyright © 2018 Webvalto Ltd.
 *
 * 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 io.devbench.uibuilder.annotations;

import io.devbench.uibuilder.api.controllerbean.UIComponent;
import io.devbench.uibuilder.api.controllerbean.uieventhandler.UIEventHandler;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;

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

/**
 * The annotation to point to special beans that servs as the controller for the frontend htmls.
 *
 * @see UIComponent
 * @see UIEventHandler
 *
 */
@Component
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ControllerBean {

    /**
     * The name of the controller bean used in bindings, and  event handlers.
     * If no value provided, that means the name should be the same as the classname uncapitalized
     */
    @AliasFor(annotation = Component.class)
    String value() default "";

}