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  import java.util.List;
20  
21  /**
22   * Extension interface for CREST subclasses of Jackson's {@code JsonSchema} to specify the enum titles.
23   */
24  interface EnumSchema {
25      String ENUM_TITLES = "enum_titles";
26  
27      /**
28       * Get the list of enum titles.
29       * @return The titles.
30       */
31      List<String> getEnumTitles();
32      /**
33       * Set the list of enum titles.
34       * @param titles The titles.
35       */
36      void setEnumTitles(List<String> titles);
37  }