FpeCompoundPart (sdkms-client 4.19.2244 API)

java.lang.Object
- com.fortanix.sdkms.v1.model.FpeCompoundPart

```
public class FpeCompoundPart
extends Object
```
Structure of a compound portion of a complex tokenization data type, itself composed of smaller parts. Note that there are three variants here: - Or -- representing an OR of multiple structures - Concat -- representing a concatenation of multiple structures - Multiple -- representing a part possibly repeated multiple times, where the part to be repeated is under the `multiple` field These three variants correspond to the `or`, `concat`, and `multiple` fields, respectively; one of these fields must be specified. It is an error to try to specify more than one variant (e.g., having both an `or` and a `concat` field). ***Implementation note: for Or variants, the parser will go in the order of the choices (see description of the `or` field below), and for Multiple variants, the parser will try to (locally) match as many repetitions as possible. (See the description of `FpeDataPart` for more information about why this matters.)***

Constructor Summary

Constructors
Constructor and Description

FpeCompoundPart()

Constructors
Constructor and Description
`FpeCompoundPart()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FpeCompoundPart`	`addConcatItem(FpeDataPart concatItem)`
`FpeCompoundPart`	`addOrItem(FpeDataPart orItem)`
`FpeCompoundPart`	`concat(List<FpeDataPart> concat)`
`FpeCompoundPart`	`constraints(FpeConstraints constraints)`
`boolean`	`equals(Object o)`
`List<FpeDataPart>`	`getConcat()` Represents a concatentation of multiple structures (in a particular order).
`FpeConstraints`	`getConstraints()` Get constraints
`Boolean`	`getMask()` Whether the entire part should be masked when doing masked decryption.
`Integer`	`getMaxLength()` The minimum allowed length for this part (in chars).
`Integer`	`getMaxRepetitions()` The maximum number of times the subpart can be repeated.
`Integer`	`getMinLength()` The minimum allowed length for this part (in chars).
`Integer`	`getMinRepetitions()` The minimum number of times the subpart can be repeated.
`FpeDataPart`	`getMultiple()` Get multiple
`List<FpeDataPart>`	`getOr()` Represents an OR of multiple structures.
`Boolean`	`getPreserve()` Whether the entire part should be preserved as-is (i.e., not tokenized).
`int`	`hashCode()`
`FpeCompoundPart`	`mask(Boolean mask)`
`FpeCompoundPart`	`maxLength(Integer maxLength)`
`FpeCompoundPart`	`maxRepetitions(Integer maxRepetitions)`
`FpeCompoundPart`	`minLength(Integer minLength)`
`FpeCompoundPart`	`minRepetitions(Integer minRepetitions)`
`FpeCompoundPart`	`multiple(FpeDataPart multiple)`
`FpeCompoundPart`	`or(List<FpeDataPart> or)`
`FpeCompoundPart`	`preserve(Boolean preserve)`
`void`	`setConcat(List<FpeDataPart> concat)`
`void`	`setConstraints(FpeConstraints constraints)`
`void`	`setMask(Boolean mask)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMaxRepetitions(Integer maxRepetitions)`
`void`	`setMinLength(Integer minLength)`
`void`	`setMinRepetitions(Integer minRepetitions)`
`void`	`setMultiple(FpeDataPart multiple)`
`void`	`setOr(List<FpeDataPart> or)`
`void`	`setPreserve(Boolean preserve)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FpeCompoundPart
```
public FpeCompoundPart()
```
- Method Detail
  - or
```
public FpeCompoundPart or(List<FpeDataPart> or)
```
  - addOrItem
```
public FpeCompoundPart addOrItem(FpeDataPart orItem)
```
  - getOr
```
public List<FpeDataPart> getOr()
```
    Represents an OR of multiple structures. This cannot be specified alongside the `concat` or `multiple` fields. ***Implementation note: the order of the choices matters, as the parser will pick the first structure that matches. (The parser is locally \"greedy\"; see the description of `FpeDataPart` for more information about why this matters.)***
    
    Returns:
    
    or
  - setOr
```
public void setOr(List<FpeDataPart> or)
```
  - concat
```
public FpeCompoundPart concat(List<FpeDataPart> concat)
```
  - addConcatItem
```
public FpeCompoundPart addConcatItem(FpeDataPart concatItem)
```
  - getConcat
```
public List<FpeDataPart> getConcat()
```
    Represents a concatentation of multiple structures (in a particular order). This cannot be specified alongside the `or` or `multiple` fields.
    
    Returns:
    
    concat
  - setConcat
```
public void setConcat(List<FpeDataPart> concat)
```
  - multiple
```
public FpeCompoundPart multiple(FpeDataPart multiple)
```
  - getMultiple
```
public FpeDataPart getMultiple()
```
    Get multiple
    
    Returns:
    
    multiple
  - setMultiple
```
public void setMultiple(FpeDataPart multiple)
```
  - minRepetitions
```
public FpeCompoundPart minRepetitions(Integer minRepetitions)
```
  - getMinRepetitions
```
public Integer getMinRepetitions()
```
    The minimum number of times the subpart can be repeated. This field should only be used if the `multiple` field is being used.
    
    Returns:
    
    minRepetitions
  - setMinRepetitions
```
public void setMinRepetitions(Integer minRepetitions)
```
  - maxRepetitions
```
public FpeCompoundPart maxRepetitions(Integer maxRepetitions)
```
  - getMaxRepetitions
```
public Integer getMaxRepetitions()
```
    The maximum number of times the subpart can be repeated. This field should only be used if the `multiple` field is being used.
    
    Returns:
    
    maxRepetitions
  - setMaxRepetitions
```
public void setMaxRepetitions(Integer maxRepetitions)
```
  - constraints
```
public FpeCompoundPart constraints(FpeConstraints constraints)
```
  - getConstraints
```
public FpeConstraints getConstraints()
```
    Get constraints
    
    Returns:
    
    constraints
  - setConstraints
```
public void setConstraints(FpeConstraints constraints)
```
  - preserve
```
public FpeCompoundPart preserve(Boolean preserve)
```
  - getPreserve
```
public Boolean getPreserve()
```
    Whether the entire part should be preserved as-is (i.e., not tokenized). If this is set, any descendant subparts cannot contain any preserve-related fields set.
    
    Returns:
    
    preserve
  - setPreserve
```
public void setPreserve(Boolean preserve)
```
  - mask
```
public FpeCompoundPart mask(Boolean mask)
```
  - getMask
```
public Boolean getMask()
```
    Whether the entire part should be masked when doing masked decryption. If this is set, any descendant subparts cannot contain any mask-related fields set.
    
    Returns:
    
    mask
  - setMask
```
public void setMask(Boolean mask)
```
  - minLength
```
public FpeCompoundPart minLength(Integer minLength)
```
  - getMinLength
```
public Integer getMinLength()
```
    The minimum allowed length for this part (in chars).
    
    Returns:
    
    minLength
  - setMinLength
```
public void setMinLength(Integer minLength)
```
  - maxLength
```
public FpeCompoundPart maxLength(Integer maxLength)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    The minimum allowed length for this part (in chars).
    
    Returns:
    
    maxLength
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FpeCompoundPart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FpeCompoundPart

Method Detail

or

addOrItem

getOr

setOr

concat

addConcatItem

getConcat

setConcat

multiple

getMultiple

setMultiple

minRepetitions

getMinRepetitions

setMinRepetitions

maxRepetitions

getMaxRepetitions

setMaxRepetitions

constraints

getConstraints

setConstraints

preserve

getPreserve

setPreserve

mask

getMask

setMask

minLength

getMinLength

setMinLength

maxLength

getMaxLength

setMaxLength

equals

hashCode

toString