com.facebook.litho.annotations.OnTrigger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of litho-annotations Show documentation

The annotations that are used in the Litho library

There is a newer version: 0.50.1

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * 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.facebook.litho.annotations;

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

/**
 * Annotated function in the component will allow its parents to call it with an EventTrigger. See
 * trigger-events for details.
 *
 * For example
 *
 * 
 * 
 *  {@literal @}LayoutSpec
 *   public class ComponentSpec {
 *
 *    {@literal @}OnTrigger(YourEvent.class)
 *     static Object yourEventClick(ComponentContext c,{@literal @}FromTrigger YourObject obj) {
 *       return new Object();
 *     }
 *   }
 * 
 * 
 *
 * @see OnEvent
 */
@Retention(RetentionPolicy.CLASS)
public @interface OnTrigger {
  Class value();
}