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.html.annotation;
014
015/**
016 * Identifies possible values for the {@link Html#format()} annotation.
017 *
018 * <h5 class='section'>See Also:</h5><ul>
019 *    <li class='link'><a class="doclink" href="../../../../../index.html#jm.HtmlDetails">HTML Details</a>
020 * </ul>
021 */
022public enum HtmlFormat {
023
024   /**
025    * Object is serialized to a String using the <c>toString()</c> method and written directly to output.
026    * <br>Useful when you want to serialize custom HTML.
027    */
028   PLAIN_TEXT,
029
030   /**
031    * Object is serialized to HTML.
032    * <br>This is the default value for serialization.
033    */
034   HTML,
035
036   /**
037    * Object is serialized to HTML, use comma-delimited format instead of list.
038    */
039   HTML_CDC,
040
041   /**
042    * Object is serialized to HTML, use space-delimited format instead of list.
043    */
044   HTML_SDC,
045
046   /**
047    * Object is serialized to XML.
048    * <br>Useful when creating beans that model HTML elements.
049    */
050   XML
051}