001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.meta.block;
019
020import net.tridentsdk.base.Block;
021
022import javax.annotation.concurrent.ThreadSafe;
023
024/**
025 * MetaData contained in a Cauldron.
026 *
027 * @author The TridentSDK Team
028 * @since 0.4-alpha
029 */
030@ThreadSafe
031public interface CauldronMeta extends BlockMeta<Block> {
032    /**
033     * Gets the filled water level of the respective cauldron.
034     * @return The water level.
035     */
036    short filledLevel();
037
038    /**
039     * Sets the filled water level of the cauldron.
040     * @param level The desired water level.
041     */
042    void setFilledLevel(short level);
043
044    /**
045     * Gets the filled water level as a percentage.
046     * @return Water level as a percentage.
047     */
048    double filledPercentage();
049}