[77] | 1 | package com.framsticks.params; |
---|
| 2 | |
---|
| 3 | import com.framsticks.params.types.DecimalParam; |
---|
| 4 | import com.framsticks.params.types.StringParam; |
---|
| 5 | |
---|
| 6 | /** |
---|
| 7 | * Based on c++ struct ParamEntry located in cpp/gdk/param.h |
---|
| 8 | * Here it is a root of Param hierarchy. |
---|
| 9 | * |
---|
| 10 | * @author Jarek Szymczak <name.surname@gmail.com>, Mateusz Jarus |
---|
| 11 | * (please replace name and surname with my personal data) |
---|
| 12 | * |
---|
| 13 | * @author Piotr Śniegowski |
---|
| 14 | */ |
---|
| 15 | public abstract class Param { |
---|
| 16 | |
---|
| 17 | /** The parameter id. */ |
---|
| 18 | protected String id; |
---|
| 19 | |
---|
| 20 | /** |
---|
| 21 | * The parameter internal id. It's set by a user to use user's own getId in |
---|
| 22 | * code |
---|
| 23 | */ |
---|
| 24 | protected String internalId; |
---|
| 25 | |
---|
| 26 | /** The parameter name. */ |
---|
| 27 | protected String name; |
---|
| 28 | |
---|
| 29 | /** The help (description) concerning parameter. */ |
---|
| 30 | protected String help; |
---|
| 31 | |
---|
| 32 | /** The number of group, that parameter belongs to. */ |
---|
| 33 | protected Integer group; |
---|
| 34 | |
---|
| 35 | /** The getFlags stored as a bit sum. */ |
---|
| 36 | protected Integer flags; |
---|
| 37 | |
---|
| 38 | /** The variable determining whether the parameter is an extra parameter. */ |
---|
| 39 | protected Integer extra; |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | public Param() { |
---|
| 43 | |
---|
| 44 | } |
---|
| 45 | |
---|
| 46 | public String getId() { |
---|
| 47 | return id; |
---|
| 48 | } |
---|
| 49 | |
---|
| 50 | public String getInternalId() { |
---|
| 51 | return internalId; |
---|
| 52 | } |
---|
| 53 | |
---|
| 54 | public String getName() { |
---|
| 55 | return name; |
---|
| 56 | } |
---|
| 57 | |
---|
| 58 | public String getHelp() { |
---|
| 59 | return help; |
---|
| 60 | } |
---|
| 61 | |
---|
| 62 | public Integer getGroup() { |
---|
| 63 | return group; |
---|
| 64 | } |
---|
| 65 | |
---|
| 66 | public Integer getFlags() { |
---|
| 67 | return flags; |
---|
| 68 | } |
---|
| 69 | |
---|
[84] | 70 | public abstract String getFramsTypeName(); |
---|
[77] | 71 | |
---|
| 72 | |
---|
| 73 | public String getEffectiveId() { |
---|
| 74 | return (internalId != null) ? internalId : id; |
---|
| 75 | } |
---|
| 76 | |
---|
| 77 | |
---|
| 78 | public Integer getExtra() { |
---|
| 79 | return extra; |
---|
| 80 | } |
---|
| 81 | |
---|
| 82 | public void setInternalId(String internalId) { |
---|
| 83 | this.internalId = internalId; |
---|
| 84 | } |
---|
| 85 | |
---|
| 86 | @Override |
---|
| 87 | public String toString() { |
---|
| 88 | return getId() + ":" + this.getClass().getSimpleName(); |
---|
| 89 | } |
---|
| 90 | |
---|
| 91 | public boolean isNumeric() { |
---|
| 92 | return false; |
---|
| 93 | } |
---|
| 94 | |
---|
[84] | 95 | public abstract Class<?> getStorageType(); |
---|
[77] | 96 | |
---|
| 97 | public boolean hasFlag(int flag) { |
---|
| 98 | return flags != null && (flags & flag) != 0; |
---|
| 99 | } |
---|
| 100 | |
---|
| 101 | public boolean isUserHidden() { |
---|
| 102 | return (flags & Flags.USERHIDDEN) != 0; |
---|
| 103 | } |
---|
| 104 | |
---|
[84] | 105 | public static FramsClass getFramsClass() { |
---|
| 106 | return new FramsClass("prop", "prop", null) |
---|
[85] | 107 | .append(Param.build().id("name").name("Name").type(StringParam.class).finish()) |
---|
| 108 | .append(Param.build().id("id").name("Id").type(StringParam.class).finish()) |
---|
| 109 | .append(Param.build().id("type").name("Type").type(StringParam.class).finish()) |
---|
| 110 | .append(Param.build().id("help").name("Help").type(StringParam.class).finish()) |
---|
| 111 | .append(Param.build().id("flags").name("Flags").type(DecimalParam.class).finish()); |
---|
[84] | 112 | } |
---|
[77] | 113 | |
---|
[85] | 114 | public static ParamBuilder build() { |
---|
| 115 | return new ParamBuilder(); |
---|
| 116 | } |
---|
| 117 | |
---|
[77] | 118 | } |
---|