PDescriptor.java

/*
 * Copyright 2015-2016 Providence Authors
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package net.morimekta.providence.descriptor;

import net.morimekta.providence.PType;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Descriptor interface for value type V.
 * <p>
 * Note that V is specified by type even though the PDescriptor interface has
 * no methods requiring that type.
 */
public interface PDescriptor {
    /**
     * The package name is derived form the .thrift file name that is parsed or
     * if read from serialized format is explicit. Note that there may be
     * package name conflicts globally.
     *
     * @return The program name of the type. If empty the type is not in any
     *         named program, e.g. primitives.
     */
    String getProgramName();

    /**
     * The name of the type is the Identifier string from the IDL.
     *
     * @return The name of the type. Not including package.
     */
    @Nonnull
    String getName();

    /**
     * This will return the qualified name of the type given the program context.
     *
     * @param programContext The program which the type should be referenced from.
     * @return The qualified name of the type. Including program if not matching with
     *         programContext.
     */
    @Nonnull
    String getQualifiedName(String programContext);

    /**
     * This will return the globally qualified name of the type given the program context.
     *
     * @return The qualified name of the type, including program name.
     */
    @Nonnull
    default String getQualifiedName() {
        return getQualifiedName(null);
    }

    /**
     * @return Get the field type.
     */
    @Nonnull
    PType getType();

    /**
     * @return The default value for the type used for default and required fields.
     *         Note that some primitive types don't support null values, and will
     *         have methods returning a default value regardless of the field
     *         required value setting.
     */
    @Nullable
    Object getDefaultValue();
}