001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.html.annotation;
018
019/**
020 * Identifies possible values for the {@link Html#format()} annotation.
021 *
022 * <h5 class='section'>See Also:</h5><ul>
023 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/HtmlBasics">HTML Basics</a>
024 * </ul>
025 */
026public enum HtmlFormat {
027
028   /**
029    * Object is serialized to a String using the <c>toString()</c> method and written directly to output.
030    * <br>Useful when you want to serialize custom HTML.
031    */
032   PLAIN_TEXT,
033
034   /**
035    * Object is serialized to HTML.
036    * <br>This is the default value for serialization.
037    */
038   HTML,
039
040   /**
041    * Object is serialized to HTML, use comma-delimited format instead of list.
042    */
043   HTML_CDC,
044
045   /**
046    * Object is serialized to HTML, use space-delimited format instead of list.
047    */
048   HTML_SDC,
049
050   /**
051    * Object is serialized to XML.
052    * <br>Useful when creating beans that model HTML elements.
053    */
054   XML
055}