File tree Expand file tree Collapse file tree
src/main/java/io/kaitai/struct Expand file tree Collapse file tree Original file line number Diff line number Diff line change 2424package io .kaitai .struct ;
2525
2626/**
27- * Interface, implemented by every enum class generated by Kaitai Struct compiler.
27+ * Interface implemented by every enum class generated by Kaitai Struct compiler.
2828 *
2929 * @since 0.11
3030 */
3131public interface IKaitaiEnum {
3232 /**
33- * Base class for all unknown variants of Kaitai-generated enums.
33+ * Base class for all unknown values of Kaitai-generated enums.
3434 *
35- * If you want to determine is the variant that you have is known or not,
36- * you can use {@code <variant > instanceof IKaitaiEnum.Unknown}.
35+ * If you want to determine is the enum value you have is known or not,
36+ * you can use {@code <value > instanceof IKaitaiEnum.Unknown}.
3737 *
38- * The descendants of this class have value semantic, like enums: their
38+ * The descendants of this class have value semantics like enums: their
3939 * {@code equals} method compares inner long values of the same class (so
4040 * {@code Unknown} values of different Kaitai enums are not equal) and
4141 * {@code hashCode} method returns {@code Objects.hash("<enum-name>", this.id())}.
@@ -48,6 +48,6 @@ public abstract class Unknown implements IKaitaiEnum {
4848 public long id () { return id ; }
4949 }
5050
51- /** Returns the underlying number which represents this enum variant . */
51+ /** Returns the underlying integer which represents this enum value . */
5252 public long id ();
5353}
You can’t perform that action at this time.
0 commit comments