com.mvp4g.client.annotation.History Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mvp4g Show documentation

Model View Presenter with Event Bus For GWT

There is a newer version: 1.6.0

/*
 * Copyright (c) 2009 - 2017 - Pierre-Laurent Coirer, Frank Hossfeld
 *
 * 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.mvp4g.client.annotation;

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

/**
 * This annotation allows to define an history converter for the framework.

 * 

 * You can define the name of the history converter thanks to the optional attribute name. If
 * you don't give a name, the framework will generate one.

 * It is recommended to affect a name only if needed.

 * 

 * This annotation also has a convertParams attribute. By default, an history converter must define
 * an handling method for each event it converts. If you set this attribute to SIMPLE, you will have
 * to define one convertToToken method for each different parameter signature. If you set this
 * attribute to NONE, you won't have to define any conversion method.

 * 

 * This annotation can be used only on classes that implements HistoryConverter.
 *
 * @author plcoirier
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface History {

  String name() default "";

  HistoryConverterType type() default HistoryConverterType.DEFAULT;

  public enum HistoryConverterType {
    DEFAULT,
    SIMPLE,
    NONE
  }

}