com.squareup.moshi.Json Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.15.1

/*
 * Copyright (C) 2015 Square, Inc.
 *
 * 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.squareup.moshi;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Customizes how a field is encoded as JSON.
 *
 * Although this annotation doesn't declare a {@link Target}, it is only honored in the following
 * elements:
 *
 * 

 *   Java class fields
 *   
Kotlin properties for use with {@code moshi-kotlin}. This includes both
 *       properties declared in the constructor and properties declared as members.
 * 
 *
 * Users of the AutoValue: Moshi
 * Extension may also use this annotation on abstract getters.
 */
@Retention(RUNTIME)
@Documented
public @interface Json {
  String name();
}