ForgePatch/src/main/java/net/minecraftforge/common/IExtensibleEnum.java

44 lines
1.5 KiB
Java

/*
* Minecraft Forge
* Copyright (c) 2016-2018.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation version 2.1
* of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package net.minecraftforge.common;
/**
* To be implemented on vanilla enums that should be enhanced with ASM to be
* extensible. If this is implemented on a class, the class must define a static
* method called "create" which takes a String (enum name), and the rest of the
* parameters matching a constructor.
* <p>
* For example, an enum with the constructor {@code MyEnum(Object foo)} would
* require the method:
*
* <pre>
* public static MyEnum create(String name, Object foo)
* {
* throw new IllegalStateException("Enum not extended");
* }
* </pre>
*
* The method contents will be replaced with ASM at runtime. Multiple
* {@code create} methods <strong>can</strong> be defined as long as each
* matches a constructor.
*/
public interface IExtensibleEnum
{
}