juneau-core/juneau-marshall/src/main/java/org/apache/juneau/http/Age.java

// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.http;

import org.apache.juneau.http.annotation.*;

/**
 * Represents a parsed <l>Age</l> HTTP response header.
 *
 * <p>
 * The age the object has been in a proxy cache in seconds.
 *
 * <h5 class='figure'>Example</h5>
 * <p class='bcode w800'>
 * 	Age: 12
 * </p>
 *
 * <h5 class='topic'>RFC2616 Specification</h5>
 *
 * The Age response-header field conveys the sender's estimate of the amount of time since the response (or its
 * revalidation) was generated at the origin server.
 * A cached response is "fresh" if its age does not exceed its freshness lifetime.
 * Age values are calculated as specified in section 13.2.3.
 *
 * <p class='bcode w800'>
 * 	Age = "Age" ":" age-value
 * 	age-value = delta-seconds
 * </p>
 *
 * <p>
 * Age values are non-negative decimal integers, representing time in seconds.
 *
 * <p>
 * If a cache receives a value larger than the largest positive integer it can represent, or if any of its age
 * calculations overflows, it MUST transmit an Age header with a value of 2147483648 (2^31).
 *
 * <p>
 * An HTTP/1.1 server that includes a cache MUST include an Age header field in every response generated from its own
 * cache.
 *
 * <p>
 * Caches SHOULD use an arithmetic type of at least 31 bits of range.
 *
 * <ul class='seealso'>
 * 	<li class='extlink'>{@doc RFC2616}
 * </ul>
 */
@Header("Age")
public final class Age extends HeaderInteger {

	/**
	 * Constructor.
	 *
	 * @param value The value for this header.
	 */
	public Age(Integer value) {
		super(value);
	}

	/**
	 * Returns a parsed <c>Age</c> header.
	 *
	 * @param value The <c>Age</c> header string.
	 * @return The parsed <c>Age</c> header, or <jk>null</jk> if the string was null.
	 */
	public static Age forString(String value) {
		if (value == null)
			return null;
		return new Age(value);
	}

	private Age(String value) {
		super(value);
	}
}