org.apache.juneau.http.ContentLength Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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;
/**
* Represents a parsed Content-Length HTTP request/response header.
*
*
* The length of the response body in octets (8-bit bytes).
*
*
Example
*
* Content-Length: 348
*
*
* RFC2616 Specification
*
* The Content-Length entity-header field indicates the size of the entity-body, in decimal number of OCTETs, sent to
* the recipient or, in the case of the HEAD method, the size of the entity-body that would have been sent had the
* request been a GET.
*
* Content-Length = "Content-Length" ":" 1*DIGIT
*
*
*
* An example is...
*
* Content-Length: 3495
*
*
*
* Applications SHOULD use this field to indicate the transfer-length of the message-body, unless this is prohibited by
* the rules in section 4.4.
*
*
* Any Content-Length greater than or equal to zero is a valid value.
* Section 4.4 describes how to determine the length of a message-body if a Content-Length is not given.
*
*
* Note that the meaning of this field is significantly different from the corresponding definition in MIME, where it is
* an optional field used within the "message/external-body" content-type.
* In HTTP, it SHOULD be sent whenever the message's length can be determined prior to being transferred, unless this is
* prohibited by the rules in section 4.4.
*
*
Additional Information
*
*/
public final class ContentLength extends HeaderInteger {
/**
* Returns a parsed Content-Length header.
*
* @param value The Content-Length header string.
* @return The parsed Content-Length header, or null if the string was null.
*/
public static ContentLength forString(String value) {
if (value == null)
return null;
return new ContentLength(value);
}
private ContentLength(String value) {
super(value);
}
}