001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.uon;
014
015/**
016 * Identifies the possible values for the {@link UonSerializer#UON_paramFormat} setting.
017 */
018public enum ParamFormat {
019
020   /**
021    * Use UON notation for values.
022    *
023    * <p>
024    * String values such as <js>"(foo='bar')"</js> will end up being quoted and escaped to <js>"'(foo=bar~'baz~')'"</js>.
025    *
026    * <p>
027    * Boolean strings (<js>"true"</js>/<js>"false"</js>) and numeric values (<js>"123"</js>) will also end up quoted
028    * (<js>"'true'"</js>, <js>"'false'"</js>, <js>"'123'"</js>.
029    */
030   UON,
031
032   /**
033    * Serialize as plain text.
034    *
035    * <p>
036    * Strings will never be quoted or escaped.
037    * <br>Maps and array constructs (<js>"(...)"</js>, <js>"@(...)"</js>) will never be used.
038    *
039    * <p>
040    * Note that this can cause errors during parsing if you're using the URL-encoding parser to parse the results since
041    * UON constructs won't be differentiable.
042    * <br>However, this is not an issue if you're simply creating queries or form posts against 3rd-party interfaces.
043    */
044   PLAINTEXT;
045}