com.backblaze.b2.json.FieldInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of b2-sdk-core Show documentation

The core logic for B2 SDK for Java. Does not include any implementations of B2WebApiClient.

There is a newer version: 6.3.0

/*
 * Copyright 2018, Backblaze Inc. All Rights Reserved.
 * License https://www.backblaze.com/using_b2_code.html
 */

package com.backblaze.b2.json;

import com.backblaze.b2.util.B2Preconditions;

import java.lang.reflect.Field;

/**
 * Information for one field in an object that is (de)serialized.
 *
 * Used by B2ObjectHandler and B2JsonObjectHandler.
 */
public final class FieldInfo implements Comparable {

    public enum FieldRequirement { REQUIRED, OPTIONAL, IGNORED }

    public final Field field;
    public final B2JsonTypeHandler handler;
    public final FieldRequirement requirement;
    public final Object defaultValueOrNull;
    public int constructorArgIndex;
    public long bit;

    /*package*/ FieldInfo(Field field, B2JsonTypeHandler handler, FieldRequirement requirement, Object defaultValueOrNull) {
        this.field = field;
        this.handler =  handler;
        this.requirement = requirement;
        this.defaultValueOrNull = defaultValueOrNull;

        this.field.setAccessible(true);
    }

    public String getName() {
        return field.getName();
    }

    public B2JsonTypeHandler getHandler() {
        return handler;
    }

    public int compareTo(@SuppressWarnings("NullableProblems") FieldInfo o) {
        return field.getName().compareTo(o.field.getName());
    }

    public void setConstructorArgIndex(int index) {
        B2Preconditions.checkArgument(index < 64);
        constructorArgIndex = index;
        bit = 1L << index;
    }

}