act.util.JsonView Maven / Gradle / Ivy

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

The ACT full stack MVC framework

There is a newer version: 1.9.2

package act.util;

/*-
 * #%L
 * ACT Framework
 * %%
 * Copyright (C) 2014 - 2017 ActFramework
 * %%
 * 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.
 * #L%
 */

import act.cli.TableView;

import java.lang.annotation.*;

/**
 * Mark a command method return value shall be displayed as a JSON object. e.g
 *
 * ```
 * [
 *  {
 *      "ID": "__act_app_stop",
 *      "onetime": true,
 *      "trigger": null
 *  },
 *  {
 *      "id": "__act_app_app_act_plugin_loaded",
 *      "onetime": true,
 *      "trigger": null
 *  }
 * ]
 * ```
 *
 * `JsonView` can be used in conjunction with {@link PropertySpec}
 * to export only specified fields
 *
 * When the command method is also used as HTTP request handler,
 * the response type will be set as `application/json`.
 *
 * @see TableView
 * @see PropertySpec
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Inherited
public @interface JsonView {
}