Skip to content

Commit 8b1bda2

Browse files
author
Ravi Nadahar
committed
Reorganize object parser and serializer class/interface structure
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
1 parent a836ecc commit 8b1bda2

17 files changed

Lines changed: 406 additions & 350 deletions

File tree

‎bundles/org.openhab.core.io.rest.core/src/main/java/org/openhab/core/io/rest/core/internal/fileformat/FileFormatResource.java‎

Lines changed: 48 additions & 48 deletions
Large diffs are not rendered by default.

‎bundles/org.openhab.core.model.item/src/org/openhab/core/model/item/internal/fileconverter/DslItemFileConverter.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
import org.openhab.core.items.ItemUtil;
3939
import org.openhab.core.items.Metadata;
4040
import org.openhab.core.items.fileconverter.AbstractItemFileGenerator;
41-
import org.openhab.core.items.fileconverter.ItemFileGenerator;
42-
import org.openhab.core.items.fileconverter.ItemFileParser;
41+
import org.openhab.core.items.fileconverter.ItemParser;
42+
import org.openhab.core.items.fileconverter.ItemSerializer;
4343
import org.openhab.core.model.core.ModelRepository;
4444
import org.openhab.core.model.item.internal.GenericItemProvider;
4545
import org.openhab.core.model.item.internal.GenericMetadataProvider;
@@ -62,8 +62,8 @@
6262
* @author Laurent Garnier - Initial contribution
6363
*/
6464
@NonNullByDefault
65-
@Component(immediate = true, service = { ItemFileGenerator.class, ItemFileParser.class })
66-
public class DslItemFileConverter extends AbstractItemFileGenerator implements ItemFileParser {
65+
@Component(immediate = true, service = { ItemSerializer.class, ItemParser.class })
66+
public class DslItemFileConverter extends AbstractItemFileGenerator implements ItemParser {
6767

6868
private final Logger logger = LoggerFactory.getLogger(DslItemFileConverter.class);
6969

@@ -86,7 +86,7 @@ public DslItemFileConverter(final @Reference ModelRepository modelRepository,
8686
}
8787

8888
@Override
89-
public String getFileFormatGenerator() {
89+
public String getGeneratedFormat() {
9090
return "DSL";
9191
}
9292

@@ -105,7 +105,7 @@ public void setItemsToBeGenerated(String id, List<Item> items, Collection<Metada
105105
}
106106

107107
@Override
108-
public void generateFileFormat(String id, OutputStream out) {
108+
public void generateFormat(String id, OutputStream out) {
109109
ItemModel model = elementsToGenerate.remove(id);
110110
if (model != null) {
111111
modelRepository.generateFileFormat(out, "items", model);
@@ -299,18 +299,18 @@ private List<ConfigParameter> getConfigurationParameters(Metadata metadata, bool
299299
}
300300

301301
@Override
302-
public String getFileFormatParser() {
302+
public String getParserFormat() {
303303
return "DSL";
304304
}
305305

306306
@Override
307-
public @Nullable String startParsingFileFormat(String syntax, List<String> errors, List<String> warnings) {
307+
public @Nullable String startParsingFormat(String syntax, List<String> errors, List<String> warnings) {
308308
ByteArrayInputStream inputStream = new ByteArrayInputStream(syntax.getBytes());
309309
return modelRepository.createIsolatedModel("items", inputStream, errors, warnings);
310310
}
311311

312312
@Override
313-
public Collection<Item> getParsedItems(String modelName) {
313+
public Collection<Item> getParsedObjects(String modelName) {
314314
return itemProvider.getAllFromModel(modelName);
315315
}
316316

‎bundles/org.openhab.core.model.thing/src/org/openhab/core/model/thing/internal/fileconverter/DslThingFileConverter.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@
4242
import org.openhab.core.thing.Thing;
4343
import org.openhab.core.thing.ThingUID;
4444
import org.openhab.core.thing.fileconverter.AbstractThingFileGenerator;
45-
import org.openhab.core.thing.fileconverter.ThingFileGenerator;
46-
import org.openhab.core.thing.fileconverter.ThingFileParser;
45+
import org.openhab.core.thing.fileconverter.ThingParser;
46+
import org.openhab.core.thing.fileconverter.ThingSerializer;
4747
import org.openhab.core.thing.link.ItemChannelLink;
4848
import org.openhab.core.thing.type.ChannelKind;
4949
import org.openhab.core.thing.type.ChannelTypeRegistry;
@@ -63,8 +63,8 @@
6363
* @author Laurent Garnier - Initial contribution
6464
*/
6565
@NonNullByDefault
66-
@Component(immediate = true, service = { ThingFileGenerator.class, ThingFileParser.class })
67-
public class DslThingFileConverter extends AbstractThingFileGenerator implements ThingFileParser {
66+
@Component(immediate = true, service = { ThingSerializer.class, ThingParser.class })
67+
public class DslThingFileConverter extends AbstractThingFileGenerator implements ThingParser {
6868

6969
private final Logger logger = LoggerFactory.getLogger(DslThingFileConverter.class);
7070

@@ -91,7 +91,7 @@ public DslThingFileConverter(final @Reference ModelRepository modelRepository,
9191
}
9292

9393
@Override
94-
public String getFileFormatGenerator() {
94+
public String getGeneratedFormat() {
9595
return "DSL";
9696
}
9797

@@ -114,7 +114,7 @@ public void setThingsToBeGenerated(String id, List<Thing> things, boolean hideDe
114114
}
115115

116116
@Override
117-
public void generateFileFormat(String id, OutputStream out) {
117+
public void generateFormat(String id, OutputStream out) {
118118
ThingModel model = elementsToGenerate.remove(id);
119119
if (model != null) {
120120
// Double quotes are unexpectedly generated in thing UID when the segment contains a -.
@@ -235,18 +235,18 @@ private ModelChannel buildModelChannel(Channel channel, boolean hideDefaultParam
235235
}
236236

237237
@Override
238-
public String getFileFormatParser() {
238+
public String getParserFormat() {
239239
return "DSL";
240240
}
241241

242242
@Override
243-
public @Nullable String startParsingFileFormat(String syntax, List<String> errors, List<String> warnings) {
243+
public @Nullable String startParsingFormat(String syntax, List<String> errors, List<String> warnings) {
244244
ByteArrayInputStream inputStream = new ByteArrayInputStream(syntax.getBytes());
245245
return modelRepository.createIsolatedModel("things", inputStream, errors, warnings);
246246
}
247247

248248
@Override
249-
public Collection<Thing> getParsedThings(String modelName) {
249+
public Collection<Thing> getParsedObjects(String modelName) {
250250
return thingProvider.getAllFromModel(modelName);
251251
}
252252

‎bundles/org.openhab.core.model.yaml/src/main/java/org/openhab/core/model/yaml/internal/items/fileconverter/YamlItemFileConverter.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
import org.openhab.core.items.ItemUtil;
4141
import org.openhab.core.items.Metadata;
4242
import org.openhab.core.items.fileconverter.AbstractItemFileGenerator;
43-
import org.openhab.core.items.fileconverter.ItemFileGenerator;
44-
import org.openhab.core.items.fileconverter.ItemFileParser;
43+
import org.openhab.core.items.fileconverter.ItemParser;
44+
import org.openhab.core.items.fileconverter.ItemSerializer;
4545
import org.openhab.core.library.CoreItemFactory;
4646
import org.openhab.core.model.yaml.YamlElement;
4747
import org.openhab.core.model.yaml.YamlModelRepository;
@@ -62,8 +62,8 @@
6262
* @author Laurent Garnier - Initial contribution
6363
*/
6464
@NonNullByDefault
65-
@Component(immediate = true, service = { ItemFileGenerator.class, ItemFileParser.class })
66-
public class YamlItemFileConverter extends AbstractItemFileGenerator implements ItemFileParser {
65+
@Component(immediate = true, service = { ItemSerializer.class, ItemParser.class })
66+
public class YamlItemFileConverter extends AbstractItemFileGenerator implements ItemParser {
6767

6868
private final YamlModelRepository modelRepository;
6969
private final YamlItemProvider itemProvider;
@@ -84,7 +84,7 @@ public YamlItemFileConverter(final @Reference YamlModelRepository modelRepositor
8484
}
8585

8686
@Override
87-
public String getFileFormatGenerator() {
87+
public String getGeneratedFormat() {
8888
return "YAML";
8989
}
9090

@@ -100,7 +100,7 @@ public void setItemsToBeGenerated(String id, List<Item> items, Collection<Metada
100100
}
101101

102102
@Override
103-
public void generateFileFormat(String id, OutputStream out) {
103+
public void generateFormat(String id, OutputStream out) {
104104
modelRepository.generateFileFormat(id, out);
105105
}
106106

@@ -283,18 +283,18 @@ private List<ConfigParameter> getConfigurationParameters(Metadata metadata, bool
283283
}
284284

285285
@Override
286-
public String getFileFormatParser() {
286+
public String getParserFormat() {
287287
return "YAML";
288288
}
289289

290290
@Override
291-
public @Nullable String startParsingFileFormat(String syntax, List<String> errors, List<String> warnings) {
291+
public @Nullable String startParsingFormat(String syntax, List<String> errors, List<String> warnings) {
292292
ByteArrayInputStream inputStream = new ByteArrayInputStream(syntax.getBytes());
293293
return modelRepository.createIsolatedModel(inputStream, errors, warnings);
294294
}
295295

296296
@Override
297-
public Collection<Item> getParsedItems(String modelName) {
297+
public Collection<Item> getParsedObjects(String modelName) {
298298
return itemProvider.getAllFromModel(modelName);
299299
}
300300

‎bundles/org.openhab.core.model.yaml/src/main/java/org/openhab/core/model/yaml/internal/things/fileconverter/YamlThingFileConverter.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@
3636
import org.openhab.core.thing.Thing;
3737
import org.openhab.core.thing.ThingUID;
3838
import org.openhab.core.thing.fileconverter.AbstractThingFileGenerator;
39-
import org.openhab.core.thing.fileconverter.ThingFileGenerator;
40-
import org.openhab.core.thing.fileconverter.ThingFileParser;
39+
import org.openhab.core.thing.fileconverter.ThingParser;
40+
import org.openhab.core.thing.fileconverter.ThingSerializer;
4141
import org.openhab.core.thing.link.ItemChannelLink;
4242
import org.openhab.core.thing.type.ChannelKind;
4343
import org.openhab.core.thing.type.ChannelType;
@@ -55,8 +55,8 @@
5555
* @author Laurent Garnier - Initial contribution
5656
*/
5757
@NonNullByDefault
58-
@Component(immediate = true, service = { ThingFileGenerator.class, ThingFileParser.class })
59-
public class YamlThingFileConverter extends AbstractThingFileGenerator implements ThingFileParser {
58+
@Component(immediate = true, service = { ThingSerializer.class, ThingParser.class })
59+
public class YamlThingFileConverter extends AbstractThingFileGenerator implements ThingParser {
6060

6161
private final YamlModelRepository modelRepository;
6262
private final YamlThingProvider thingProvider;
@@ -79,7 +79,7 @@ public YamlThingFileConverter(final @Reference YamlModelRepository modelReposito
7979
}
8080

8181
@Override
82-
public String getFileFormatGenerator() {
82+
public String getGeneratedFormat() {
8383
return "YAML";
8484
}
8585

@@ -94,7 +94,7 @@ public void setThingsToBeGenerated(String id, List<Thing> things, boolean hideDe
9494
}
9595

9696
@Override
97-
public void generateFileFormat(String id, OutputStream out) {
97+
public void generateFormat(String id, OutputStream out) {
9898
modelRepository.generateFileFormat(id, out);
9999
}
100100

@@ -165,18 +165,18 @@ private YamlChannelDTO buildChannelDTO(Channel channel, boolean hideDefaultParam
165165
}
166166

167167
@Override
168-
public String getFileFormatParser() {
168+
public String getParserFormat() {
169169
return "YAML";
170170
}
171171

172172
@Override
173-
public @Nullable String startParsingFileFormat(String syntax, List<String> errors, List<String> warnings) {
173+
public @Nullable String startParsingFormat(String syntax, List<String> errors, List<String> warnings) {
174174
ByteArrayInputStream inputStream = new ByteArrayInputStream(syntax.getBytes());
175175
return modelRepository.createIsolatedModel(inputStream, errors, warnings);
176176
}
177177

178178
@Override
179-
public Collection<Thing> getParsedThings(String modelName) {
179+
public Collection<Thing> getParsedObjects(String modelName) {
180180
return thingProvider.getAllFromModel(modelName);
181181
}
182182

‎bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/fileconverter/AbstractThingFileGenerator.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
* @author Laurent Garnier - Initial contribution
4343
*/
4444
@NonNullByDefault
45-
public abstract class AbstractThingFileGenerator implements ThingFileGenerator {
45+
public abstract class AbstractThingFileGenerator implements ThingSerializer {
4646

4747
protected final ThingTypeRegistry thingTypeRegistry;
4848
protected final ChannelTypeRegistry channelTypeRegistry;

‎bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/fileconverter/ThingFileGenerator.java‎

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/fileconverter/ThingFileParser.java‎

Lines changed: 0 additions & 71 deletions
This file was deleted.

0 commit comments

Comments
 (0)