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;
014
015/**
016 * Identifies possible values for the {@link HtmlSerializer#HTML_uriAnchorText} setting.
017 */
018public enum AnchorText {
019
020   /**
021    * Set to whatever is returned by {@link #toString()} on the object.
022    */
023   TO_STRING,
024
025   /**
026    * Set to the bean property name.
027    */
028   PROPERTY_NAME,
029
030   /**
031    * Set to the URI value.
032    *
033    * <p>
034    * This is the same as {@link #TO_STRING} but strips off the anchor tag if present.
035    */
036   URI,
037
038   /**
039    * Set to the last token of the URI value.
040    */
041   LAST_TOKEN,
042
043   /**
044    * Set to the anchor of the URL.
045    *
046    * <p>
047    * (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
048    */
049   URI_ANCHOR,
050
051   /**
052    * Same as {@link #TO_STRING} but assumes it's a context-relative path.
053    */
054   CONTEXT_RELATIVE,
055
056   /**
057    * Same as {@link #TO_STRING} but assumes it's a servlet-relative path.
058    */
059   SERVLET_RELATIVE,
060
061   /**
062    * Same as {@link #TO_STRING} but assumes it's a path-relative path.
063    */
064   PATH_RELATIVE
065}