BinaryField (MicroStream API)

All Superinterfaces:

PersistenceTypeDefinitionMember, PersistenceTypeDefinitionMemberField, PersistenceTypeDefinitionMemberFieldGeneric, PersistenceTypeDescriptionMember, PersistenceTypeDescriptionMemberField, PersistenceTypeDescriptionMemberFieldGeneric

All Known Subinterfaces:

BinaryField.Initializable

All Known Implementing Classes:

BinaryField.Default
```
public interface BinaryField
extends PersistenceTypeDefinitionMemberFieldGeneric
```

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class BinaryField.Default

static interface BinaryField.Defaults

static interface BinaryField.Initializable
- Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceTypeDescriptionMember
  PersistenceTypeDescriptionMember.IdentityHashEqualator
- Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceTypeDescriptionMemberField
  PersistenceTypeDescriptionMemberField.Abstract
- Nested classes/interfaces inherited from interface one.microstream.persistence.types.PersistenceTypeDescriptionMemberFieldGeneric
  PersistenceTypeDescriptionMemberFieldGeneric.Abstract

Method Summary

Modifier and Type	Method	Description
`static BinaryField`	`Bytes()`
`static BinaryField`	`Bytes(String name)`
`static BinaryField`	`Chars()`
`static BinaryField`	`Chars(String name)`
`static BinaryField`	`Complex(String name, PersistenceTypeDefinitionMemberFieldGeneric... nestedFields)`
`static BinaryField`	`Complex(PersistenceTypeDefinitionMemberFieldGeneric... nestedFields)`
`default BinaryField`	`copyForName(String name)`
`BinaryField`	`copyForName(String qualifier, String name)`
`String`	`name()`	The simple or "primary" name of the member, if applicable.
`static BinaryField`	`New(Class<?> type)`
`static BinaryField`	`New(Class<?> type, String name)`
`long`	`offset()`
`Class<?>`	`type()`	The runtime type used by this description member, if possible.

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDefinitionMember
runtimeQualifier

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDefinitionMemberField
field

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDescriptionMember
assembleTypeDescription, createDefinitionMember, equalsDescription, equalsStructure, hasReferences, identifier, isEnumConstant, isFixedLength, isIdentical, isPrimitive, isPrimitiveDefinition, isReference, isValidPersistentLength, isVariableLength, persistentMaximumLength, persistentMinimumLength, validatePersistentLength

Methods inherited from interface one.microstream.persistence.types.PersistenceTypeDescriptionMemberField
isInstanceMember, qualifier, typeName

Method Detail

type
```
Class<?> type()
```
Description copied from interface: PersistenceTypeDefinitionMember

The runtime type used by this description member, if possible. Otherwise null.

Specified by:

type in interface PersistenceTypeDefinitionMember

name
```
String name()
```
Description copied from interface: PersistenceTypeDescriptionMember

The simple or "primary" name of the member, if applicable. E.g. "lastName".
May be null if not applicable.

Specified by:

name in interface PersistenceTypeDescriptionMember

Specified by:

name in interface PersistenceTypeDescriptionMemberField

Returns:

the member's simple name.

offset
```
long offset()
```

copyForName
```
default BinaryField copyForName(String name)
```
Specified by:

copyForName in interface PersistenceTypeDefinitionMemberFieldGeneric

copyForName

BinaryField copyForName(String qualifier,
                        String name)

Specified by:: copyForName in interface PersistenceTypeDefinitionMemberFieldGeneric

New

static BinaryField New(Class<?> type)

New

static BinaryField New(Class<?> type,
                       String name)

Complex

static BinaryField Complex(PersistenceTypeDefinitionMemberFieldGeneric... nestedFields)

Complex

static BinaryField Complex(String name,
                           PersistenceTypeDefinitionMemberFieldGeneric... nestedFields)

Bytes
```
static BinaryField Bytes()
```

Bytes

static BinaryField Bytes(String name)

Chars
```
static BinaryField Chars()
```

Chars

static BinaryField Chars(String name)