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 org.apache.juneau.internal.*;
016
017/**
018 * Category of headers that consist of a single string value.
019 *
020 * <p>
021 * <h5 class='figure'>Example</h5>
022 * <p class='bcode w800'>
023 *    Accept-Ranges: bytes
024 * </p>
025 *
026 * <ul class='seealso'>
027 *    <li class='extlink'>{@doc RFC2616}
028 * </ul>
029 */
030public class HeaderString {
031
032   final String value;
033
034   /**
035    * Constructor.
036    *
037    * @param value The raw header value.
038    */
039   protected HeaderString(String value) {
040      this.value = StringUtils.trim(value);
041   }
042
043   /**
044    * Returns <jk>true</jk> if the specified value is the same using {@link String#equalsIgnoreCase(String)}.
045    *
046    * @param compare The value to compare against.
047    * @return <jk>true</jk> if the specified value is the same.
048    */
049   public boolean eqIC(String compare) {
050      return value.equalsIgnoreCase(compare);
051   }
052
053   /**
054    * Returns <jk>true</jk> if the specified value is the same using {@link String#equals(Object)}.
055    *
056    * @param compare The value to compare against.
057    * @return <jk>true</jk> if the specified value is the same.
058    */
059   public boolean eq(String compare) {
060      return value.equals(compare);
061   }
062
063   /**
064    * Returns this header as a simple string value.
065    *
066    * <p>
067    * Functionally equivalent to calling {@link #toString()}.
068    *
069    * @return This header as a simple string.
070    */
071   public String asString() {
072      return value;
073   }
074
075   @Override /* Object */
076   public String toString() {
077      return value == null ? "" : value;
078   }
079}