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.http;
014
015import java.net.*;
016
017import org.apache.juneau.internal.*;
018
019/**
020 * Category of headers that consist of a single URL value.
021 *
022 * <p>
023 * <h5 class='figure'>Example</h5>
024 * <p class='bcode w800'>
025 *    Location: http://www.w3.org/pub/WWW/People.html
026 * </p>
027 *
028 * <ul class='seealso'>
029 *    <li class='extlink'>{@doc RFC2616}
030 * </ul>
031 */
032public class HeaderUri{
033
034   final String value;
035
036   /**
037    * Constructor.
038    *
039    * @param value The raw header value.
040    */
041   protected HeaderUri(String value) {
042      this.value = StringUtils.trim(value);
043   }
044
045   /**
046    * Returns this header as a {@link URI}.
047    *
048    * @return This header as a {@link URI}.
049    */
050   public URI asURI() {
051      return URI.create(toString());
052   }
053
054   /**
055    * Returns this header as a simple string value.
056    *
057    * <p>
058    * Functionally equivalent to calling {@link #toString()}.
059    *
060    * @return This header as a simple string.
061    */
062   public String asString() {
063      return value;
064   }
065
066   @Override /* Object */
067   public String toString() {
068      return value == null ? "" : value;
069   }
070}