jenkins.scm.api

Class SCMFile

java.lang.Object

jenkins.scm.api.SCMFile

public abstract class SCMFile
extends Object

A file/directory inspected by SCMFileSystem.

Author:

Stephen Connolly, Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
SCMFile()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Iterable<SCMFile>	children() If this object represents a directory, lists up all the immediate children.
abstract InputStream	content() Reads the content of this file.
byte[]	contentAsBytes() A convenience method that reads the content and then turns it into a byte array.
String	contentAsString() A convenience method that reads the content and then turns it into a string.
Charset	contentEncoding() Encoding of this file.
String	contentMimeType() Returns the MIME type of this file.
abstract SCMFile	get(String path) Gets a child/descendant path relative from this object.
abstract String	getName() Gets the file name of this file without any path portion, such as just "foo.txt" This method is the equivalent of File.getName()
boolean	isContentBinary() Checks if this file is a binary file.
boolean	isContentText() The opposite of isContentBinary()
boolean	isDirectory() Returns true if this object represents a directory.
abstract boolean	isFile() Returns true if this object represents a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SCMFile

public SCMFile()

Method Detail

getName

@NonNull
public abstract String getName()

Gets the file name of this file without any path portion, such as just "foo.txt"

This method is the equivalent of File.getName()

get

@CheckForNull
public abstract SCMFile get(String path)
                     throws IOException

Gets a child/descendant path relative from this object.

Returns:

null if there's no file/directory at the path represented by it.

Throws:

IOException

children

@NonNull
public abstract Iterable<SCMFile> children()
                                    throws IOException

If this object represents a directory, lists up all the immediate children.

This method is the equivalent of File.listFiles().

Returns:

Always non-null. If this method is not a directory, this method returns an empty iterable.

Throws:

IOException

isFile

public abstract boolean isFile()
                        throws IOException

Returns true if this object represents a file.

This method is the equivalent of File.isFile()

Throws:

IOException

isDirectory

public boolean isDirectory()
                    throws IOException

Returns true if this object represents a directory.

This method is the equivalent of File.isDirectory()

Throws:

IOException

content

@NonNull
public abstract InputStream content()
                             throws IOException

Reads the content of this file.

Throws:

IOException - if this object represents a directory.

contentAsBytes

@NonNull
public byte[] contentAsBytes()
                      throws IOException

A convenience method that reads the content and then turns it into a byte array.

Throws:

IOException - if this object represents a directory.

contentAsString

@NonNull
public String contentAsString()
                       throws IOException

A convenience method that reads the content and then turns it into a string.

Throws:

IOException - if this object represents a directory.

contentMimeType

@NonNull
public String contentMimeType()
                       throws IOException

Returns the MIME type of this file.

The default implementation infers this based on the file name, but sophisticated server might provide this information from different sources, such as "svn:mime-type" in Subversion.

Throws:

IOException

isContentBinary

public boolean isContentBinary()
                        throws IOException

Checks if this file is a binary file.

What exactly is a binary file is up to the implementation. Some SCMs (such as Subversion) has a way of letting users mark files as binaries.

Throws:

IOException

isContentText

public boolean isContentText()
                      throws IOException

The opposite of isContentBinary()

Throws:

IOException

contentEncoding

@NonNull
public Charset contentEncoding()
                        throws IOException

Encoding of this file.

This is used to interpret text files.

Some SCM implementations allow users to mark content encoding of files, and this method may provide those. As a fallback, the default implementation returns the platform default encoding.

Throws:

IOException