org.opentest4j:opentest4j 1.3.0 · org.opentest4j.FileInfo

Modifier and Type	Field and Description
private final byte[]	contents
private final String	path
private static final long	serialVersionUID

Access	Constructor and Description
public	FileInfo(String the path to the file; must not be `null` path, byte[] the contents of the file; must not be `null`; contents) Constructs a `FileInfo` with a path to a file and the contents of the file.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Determines if the supplied object is an instance of `FileInfo` with the same path and contents as this `FileInfo`.
public byte[]	Returns: the contents of the file; never `null` getContents() Returns the contents of the file.
public String	Returns: the contents of the file as a `String`; never `null` getContentsAsString(Charset charset) Returns the contents of the file as a `String`.
public String	Returns: the path to the file; never `null` getPath() Returns the path to the file.
public int	hashCode() Overrides java.lang.Object.hashCode. Generates a unique hash code for this `FileInfo` based on its `path`.
public String	toString() Overrides java.lang.Object.toString. Generates a string representation of this `FileInfo` based on the `path` and `contents`.
private static void	validatePath(String path)

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

Field Detail

contents	back to summary
private final byte[] contents

path	back to summary
private final String path

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

FileInfo back to summary

FileInfo	back to summary
public FileInfo(String path, byte[] contents) Constructs a `FileInfo` with a path to a file and the contents of the file. Be cautious with large files (limiting the size may be a good idea). The supplied byte array is not copied to avoid unnecessary memory allocations. However, callers of this constructors should not modify the byte array after calling this constructor. This behavior may change in a future release without prior notice. Parameters path:String the path to the file; must not be `null` contents:byte[] the contents of the file; must not be `null`;

public FileInfo(String path, byte[] contents)

Constructs a FileInfo with a path to a file and the contents of the file.

Be cautious with large files (limiting the size may be a good idea).

The supplied byte array is not copied to avoid unnecessary memory allocations. However, callers of this constructors should not modify the byte array after calling this constructor. This behavior may change in a future release without prior notice.

Parameters

path:String: the path to the file; must not be null
contents:byte[]: the contents of the file; must not be null;

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Determines if the supplied object is an instance of `FileInfo` with the same path and contents as this `FileInfo`. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Determines if the supplied object is an instance of FileInfo with the same path and contents as this FileInfo.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getContents back to summary

getContents	back to summary
public byte[] getContents() Returns the contents of the file. This method does currently not return a defensive copy of the contained byte array to avoid unnecessary memory allocations. However, callers of this method should not modify the returned byte array. This behavior may change in a future release without prior notice. Returns:byte[] the contents of the file; never `null`

public byte[] getContents()

Returns the contents of the file.

This method does currently not return a defensive copy of the contained byte array to avoid unnecessary memory allocations. However, callers of this method should not modify the returned byte array. This behavior may change in a future release without prior notice.

Returns:byte[]: the contents of the file; never null

getContentsAsString back to summary

getContentsAsString	back to summary
public String getContentsAsString(Charset charset) Returns the contents of the file as a `String`. Returns:String the contents of the file as a `String`; never `null`

public String getContentsAsString(Charset charset)

Returns the contents of the file as a String.

Returns:String: the contents of the file as a String; never null

getPath back to summary

getPath	back to summary
public String getPath() Returns the path to the file. Returns:String the path to the file; never `null`

public String getPath()

Returns the path to the file.

Returns:String: the path to the file; never null

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Generates a unique hash code for this `FileInfo` based on its `path`. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Generates a unique hash code for this FileInfo based on its path.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Generates a string representation of this `FileInfo` based on the `path` and `contents`. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Generates a string representation of this FileInfo based on the path and contents.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

validatePath	back to summary
private static void validatePath(String path)

public Class FileInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail