Apache HttpComponents Core HTTP/1.1 5.2.4 · org.apache.hc.core5.http.message.BasicHeader

Modifier and Type	Field and Description
private final String	name
private final boolean	sensitive
private static final long	serialVersionUID
private final String	value

Access	Constructor and Description
public	BasicHeader(final String the header name name, final Object the header value, taken as the value's `toString()`. value) Default constructor
public	BasicHeader(final String the header name name, final Object the header value, taken as the value's `toString()`. value, final boolean sensitive flag sensitive) Constructor with sensitivity flag

Method Summary

Modifier and Type	Method and Description
public BasicHeader	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public String	getName() Implements org.apache.hc.core5.http.NameValuePair.getName. Gets the name of this pair.
public String	getValue() Implements org.apache.hc.core5.http.NameValuePair.getValue. Gets the value of this pair.
public boolean	isSensitive() Implements org.apache.hc.core5.http.Header.isSensitive. Returns `true` if the header should be considered sensitive.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

name	back to summary
private final String name

sensitive	back to summary
private final boolean sensitive

serialVersionUID	back to summary
private static final long serialVersionUID

value	back to summary
private final String value

BasicHeader	back to summary
public BasicHeader(final String name, final Object value) Default constructor Parameters name:String the header name value:Object the header value, taken as the value's `toString()`.

BasicHeader	back to summary
public BasicHeader(final String name, final Object value, final boolean sensitive) Constructor with sensitivity flag Parameters name:String the header name value:Object the header value, taken as the value's `toString()`. sensitive:boolean sensitive flag Since 5.0

Method Detail

clone back to summary

clone	back to summary
public BasicHeader clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:BasicHeader a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public BasicHeader clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:BasicHeader

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

getName back to summary

getName	back to summary
public String getName() Implements org.apache.hc.core5.http.NameValuePair.getName. Doc from org.apache.hc.core5.http.NameValuePair.getName. Gets the name of this pair. Returns:String the name of this pair, never `null`. Annotations @Override

public String getName()

Implements org.apache.hc.core5.http.NameValuePair.getName.

Doc from org.apache.hc.core5.http.NameValuePair.getName.

Gets the name of this pair.

Returns:String

the name of this pair, never null.

Annotations

@Override

getValue back to summary

getValue	back to summary
public String getValue() Implements org.apache.hc.core5.http.NameValuePair.getValue. Doc from org.apache.hc.core5.http.NameValuePair.getValue. Gets the value of this pair. Returns:String the value of this pair, may be `null`. Annotations @Override

public String getValue()

Implements org.apache.hc.core5.http.NameValuePair.getValue.

Doc from org.apache.hc.core5.http.NameValuePair.getValue.

Gets the value of this pair.

Returns:String

the value of this pair, may be null.

Annotations

@Override

isSensitive back to summary

isSensitive	back to summary
public boolean isSensitive() Implements org.apache.hc.core5.http.Header.isSensitive. Doc from org.apache.hc.core5.http.Header.isSensitive. Returns `true` if the header should be considered sensitive. Some encoding schemes such as HPACK impose restrictions on encoded representation of sensitive headers. Returns:boolean `true` if the header should be considered sensitive. Annotations @Override

public boolean isSensitive()

Implements org.apache.hc.core5.http.Header.isSensitive.

Doc from org.apache.hc.core5.http.Header.isSensitive.

Returns true if the header should be considered sensitive.

Some encoding schemes such as HPACK impose restrictions on encoded representation of sensitive headers.

Returns:boolean

true if the header should be considered sensitive.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class BasicHeader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail