View Javadoc
1   /*
2    * The contents of this file are subject to the terms of the Common Development and
3    * Distribution License (the License). You may not use this file except in compliance with the
4    * License.
5    *
6    * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7    * specific language governing permission and limitations under the License.
8    *
9    * When distributing Covered Software, include this CDDL Header Notice in each file and include
10   * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11   * Header, with the fields enclosed by brackets [] replaced by your own identifying
12   * information: "Portions copyright [year] [name of copyright owner]".
13   *
14   * Copyright 2016 ForgeRock AS.
15   */
16  
17  package org.forgerock.api.jackson;
18  
19  /**
20   * Extension interface for CREST subclasses of Jackson's {@code JsonSchema} to specify the property order schema field.
21   */
22  interface OrderedFieldSchema {
23  
24      /**
25       * Get the property order number.
26       * @return The property order.
27       */
28      Integer getPropertyOrder();
29  
30      /**
31       * Set the property order number.
32       * @param order The property order.
33       */
34      void setPropertyOrder(Integer order);
35  }