jakarta.json.bind.annotation.JsonbPropertyOrder Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.json.bind.annotation;

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

/**
 * Specifies order in which properties are serialized.
 *
 * Partial mapping can also be specified. In that case, properties included in annotation
 * declaration will be serialized first (in defined order), followed by any properties not included
 * in the definition. The order of properties not included in the definition is not guaranteed.
 *
 * @since JSON Binding 1.0
 */
@JsonbAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
public @interface JsonbPropertyOrder {

  /**
   * Order in which properties are serialized. Names must correspond to original names defined in
   * Java class before any customization applied.
   *
   * @return Array of property names which defines an order.
   */
  String[] value();
}