com.flowpowered.nbt.holder.Field Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flow-nbt Show documentation

Named Binary Tag (NBT) library for Java based on Graham Edgecombe's JNBT library.

The newest version!

/*
 * This file is part of Flow NBT, licensed under the MIT License (MIT).
 *
 * Copyright (c) 2011 Flow Powered 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.flowpowered.nbt.holder;

import com.flowpowered.nbt.Tag;

/**
 * Base field in NBT serialization
 */
public interface Field {
    /**
     * Get the value of this field from the given tag
     *
     * @param tag The tag to use
     * @return The value
     * @throws IllegalArgumentException when the tag is of the wrong type
     */
    public T getValue(Tag tag) throws IllegalArgumentException;

    /**
     * Convert a value to its serialized NBT form
     *
     * @param name The key to use for the NBT tag
     * @param value The value
     * @return The value serialized to a tag
     */
    public Tag getValue(String name, T value);
}