com.ibm.cloud.objectstorage.services.s3.model

Class ExtraMaterialsDescription

java.lang.Object

com.ibm.cloud.objectstorage.services.s3.model.ExtraMaterialsDescription

All Implemented Interfaces:

Serializable

public class ExtraMaterialsDescription
extends Object
implements Serializable

Used to provide additional/supplemental material description (typically on a per-request basis and for more advanced use-case) to supplement the one stored in S3 for crypto material retrieval.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtraMaterialsDescription.ConflictResolution Used to resolve conflicts when merging the additional material description to the core material description.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtraMaterialsDescription	NONE

Constructor Summary

Constructors

Constructor and Description
ExtraMaterialsDescription(Map<String,String> matdesc)
ExtraMaterialsDescription(Map<String,String> matdesc, ExtraMaterialsDescription.ConflictResolution resolve)

Method Summary

Modifier and Type	Method and Description
ExtraMaterialsDescription.ConflictResolution	getConflictResolution() Returns the conflict resolution strategy; neve null.
Map<String,String>	getMaterialDescription() Returns the extra material description; never null.
Map<String,String>	mergeInto(Map<String,String> core) Combine this supplemental material descriptions with those specified in the "core" parameter.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final ExtraMaterialsDescription NONE

Constructor Detail

ExtraMaterialsDescription

public ExtraMaterialsDescription(Map<String,String> matdesc)

ExtraMaterialsDescription

public ExtraMaterialsDescription(Map<String,String> matdesc,
                                 ExtraMaterialsDescription.ConflictResolution resolve)

Method Detail

getMaterialDescription

public Map<String,String> getMaterialDescription()

Returns the extra material description; never null.

getConflictResolution

public ExtraMaterialsDescription.ConflictResolution getConflictResolution()

Returns the conflict resolution strategy; neve null.

mergeInto

public Map<String,String> mergeInto(Map<String,String> core)

Combine this supplemental material descriptions with those specified in the "core" parameter. This method has no side effect.

Parameters:

core - the core material descriptions to be supplemented; assumed to be unmodifiable.

Returns:

the merged material descriptions; never null. The returned map is always unmodifiable, assuming the passed in core material descriptions are unmodifiable.

Throws:

IllegalArgumentException - if this supplemental material descriptions contains conflicting entries

UnsupportedOperationException - if the conflict resolution strategy is not supported