org.jimmutable.aws.s3

Class S3Path

java.lang.Object

org.jimmutable.core.objects.StandardObject<T>

org.jimmutable.core.objects.StandardImmutableObject<org.jimmutable.core.objects.Stringable>

org.jimmutable.core.objects.Stringable

org.jimmutable.aws.s3.S3Path

All Implemented Interfaces:

Comparable<org.jimmutable.core.objects.Stringable>, org.jimmutable.core.serialization.writer.StandardWritable

public class S3Path
extends org.jimmutable.core.objects.Stringable

A nice class for working with S3 object paths. Characters are limited to a-z, 0-9, dashes (-) and dots (.) and slashes / Names may not start or end with a . or - Names may not contain //, --, or .. Names may not be longer than 1024 characters

Author:

jim.kane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3Path.MyConverter

Nested classes/interfaces inherited from class org.jimmutable.core.objects.Stringable

org.jimmutable.core.objects.Stringable.Converter<S extends org.jimmutable.core.objects.Stringable>

Field Summary

Fields

Modifier and Type	Field and Description
static S3Path.MyConverter	CONVERTER
static S3Path	PATH_BUCKET_ROOT

Fields inherited from class org.jimmutable.core.objects.Stringable

TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
S3Path(String code)

Method Summary

Modifier and Type	Method and Description
String	getOptionalExtension(String default_value) Get the "extension" of the last part of the path.
String	getOptionalLastPart(String default_value) Get the last part of a path.
S3Path	getOptionalParent(S3Path default_value) Get the parent of this path
String	getOptionalPart(int idx, String default_value) Get the part at a given index
int	getSimpleNumberOfParts() Get the number of parts of a path.
List<String>	getSimpleParts() Get the parts of a path.
boolean	hasExtension() Does this path have an extension? foo/bar/baz.txt returns true foo returns false
boolean	hasLastPart() Does this path have a "last" part?
boolean	hasParent() Does this path have a parent?
void	normalize()
void	validate()

Methods inherited from class org.jimmutable.core.objects.Stringable

compareTo, equals, freeze, getSimpleValue, getTypeName, hashCode, normalizeLowerCase, normalizeTrim, normalizeUpperCase, setValue, toString, write

Methods inherited from class org.jimmutable.core.objects.StandardImmutableObject

assertNotComplete, complete, deepClone, isComplete

Methods inherited from class org.jimmutable.core.objects.StandardObject

deserialize, serialize, toJavaCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATH_BUCKET_ROOT

public static S3Path PATH_BUCKET_ROOT

CONVERTER

public static final S3Path.MyConverter CONVERTER

Constructor Detail

S3Path

public S3Path(String code)

Method Detail

normalize

public void normalize()

Specified by:

normalize in class org.jimmutable.core.objects.StandardObject<org.jimmutable.core.objects.Stringable>

validate

public void validate()

Specified by:

validate in class org.jimmutable.core.objects.StandardObject<org.jimmutable.core.objects.Stringable>

getSimpleParts

public List<String> getSimpleParts()

Get the parts of a path. For example, the path foo/bar/baz.txt has the parts [foo, bar, baz.txt]

Returns:

An immutable list containing the parts of the path

getSimpleNumberOfParts

public int getSimpleNumberOfParts()

Get the number of parts of a path. For example, the path foo/bar/baz.txt would return 3. PATH_BUCKET_ROOT.getSimpleNumberOfParts() returns 0

Returns:

The number of parts in the path

getOptionalPart

public String getOptionalPart(int idx,
                              String default_value)

Get the part at a given index

Parameters:

idx - The index of the part to get

default_value - The value to return if no part exists at the specified index

Returns:

The part at the specified index, or default_value if that part does not exist

hasLastPart

public boolean hasLastPart()

Does this path have a "last" part?

Returns:

True if the path has a last part, false otherwise

getOptionalLastPart

public String getOptionalLastPart(String default_value)

Get the last part of a path. For example, the path foo/bar/baz.txt has the last part baz.txt

Parameters:

default_value - The value to return if the path does not have a last part

Returns:

The last part of the path (if the path has a last part) or default_value if it does not

hasExtension

public boolean hasExtension()

Does this path have an extension? foo/bar/baz.txt returns true foo returns false

Returns:

True if this path has a filename extension, false otherwise

getOptionalExtension

public String getOptionalExtension(String default_value)

Get the "extension" of the last part of the path. For example, the path foo/bar/baz.html.jpg.txt has the extension.txt

Parameters:

default_value - The value to return if the path does not have an extension

Returns:

the extension of the path (if the path has an extension, default_value otherwise)

hasParent

public boolean hasParent()

Does this path have a parent?

Returns:

True if this path has a parent, false otherwise

getOptionalParent

public S3Path getOptionalParent(S3Path default_value)

Get the parent of this path

Parameters:

default_value - The value to return if this path does not have a parent

Returns:

The parent of this path, or defaul_value if the path does not have a parent