diff --git a/pi4j-core/src/main/java/com/pi4j/Pi4J.java b/pi4j-core/src/main/java/com/pi4j/Pi4J.java index 1a968ef4..fe0889ed 100644 --- a/pi4j-core/src/main/java/com/pi4j/Pi4J.java +++ b/pi4j-core/src/main/java/com/pi4j/Pi4J.java @@ -34,12 +34,6 @@ import java.io.InputStream; import java.util.Properties; -/** - *
Pi4J class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class Pi4J { private static final Logger logger = LoggerFactory.getLogger(Pi4J.class); @@ -109,17 +103,12 @@ public void log() { } } - /** - * @return {@link BuildInfo} - */ public static BuildInfo getBuildInfo() { return buildInfo; } /** * Reads the build info from the build.properties file. - * - * @return {@link BuildInfo} */ private static BuildInfo loadBuildInfo() { try (InputStream is = Pi4J.class.getResourceAsStream("/build.properties")) { diff --git a/pi4j-core/src/main/java/com/pi4j/boardinfo/util/PwmChipUtil.java b/pi4j-core/src/main/java/com/pi4j/boardinfo/util/PwmChipUtil.java index d9f4f223..666f29e4 100644 --- a/pi4j-core/src/main/java/com/pi4j/boardinfo/util/PwmChipUtil.java +++ b/pi4j-core/src/main/java/com/pi4j/boardinfo/util/PwmChipUtil.java @@ -77,7 +77,7 @@ public class PwmChipUtil { *Describable interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public interface Describable { - /** - *describe.
- * - * @return a {@link com.pi4j.common.Descriptor} object. - */ Descriptor describe(); } diff --git a/pi4j-core/src/main/java/com/pi4j/common/Descriptor.java b/pi4j-core/src/main/java/com/pi4j/common/Descriptor.java index 4e34949b..6bf99f6e 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/Descriptor.java +++ b/pi4j-core/src/main/java/com/pi4j/common/Descriptor.java @@ -29,161 +29,50 @@ import java.io.PrintStream; -/** - *Descriptor interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public interface Descriptor { - /** - *id.
- * - * @param id a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ Descriptor id(String id); - /** - *name.
- * - * @param name a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ + Descriptor name(String name); - /** - *description.
- * - * @param description a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ + Descriptor description(String description); - /** - *category.
- * - * @param category a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ + Descriptor category(String category); - /** - *quantity.
- * - * @param quantity a {@link java.lang.Integer} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ + Descriptor quantity(Integer quantity); - /** - *type.
- * - * @param type a {@link java.lang.Class} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ + Descriptor type(Class type); - /** - *parent.
- * - * @param parent a {@link com.pi4j.common.Descriptor} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ Descriptor parent(Descriptor parent); - /** - *value.
- * - * @param value a {@link java.lang.Object} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ Descriptor value(Object value); - /** - *id.
- * - * @return a {@link java.lang.String} object. - */ String id(); - /** - *name.
- * - * @return a {@link java.lang.String} object. - */ + String name(); - /** - *category.
- * - * @return a {@link java.lang.String} object. - */ + String category(); - /** - *description.
- * - * @return a {@link java.lang.String} object. - */ + String description(); - /** - *quantity.
- * - * @return a {@link java.lang.Integer} object. - */ + Integer quantity(); - /** - *value.
- * - * @return a {@link java.lang.Object} object. - */ + Object value(); - /** - *type.
- * - * @return a {@link java.lang.Class} object. - */ + Class type(); - /** - *parent.
- * - * @return a {@link com.pi4j.common.Descriptor} object. - */ + Descriptor parent(); - /** - *create.
- * - * @return a {@link com.pi4j.common.Descriptor} object. - */ - static Descriptor create(){ + static Descriptor create() { return new DescriptorImpl(); } - /** - *add.
- * - * @param descriptor a {@link com.pi4j.common.Descriptor} object. - * @return a {@link com.pi4j.common.Descriptor} object. - */ Descriptor add(Descriptor descriptor); - /** - *size.
- * - * @return a int. - */ int size(); - /** - *isEmpty.
- * - * @return a boolean. - */ + boolean isEmpty(); - /** - *isNotEmpty.
- * - * @return a boolean. - */ + boolean isNotEmpty(); - /** - *print.
- * - * @param stream a {@link java.io.PrintStream} object. - */ void print(PrintStream stream); } diff --git a/pi4j-core/src/main/java/com/pi4j/common/Identity.java b/pi4j-core/src/main/java/com/pi4j/common/Identity.java index aa482a2f..68b802c8 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/Identity.java +++ b/pi4j-core/src/main/java/com/pi4j/common/Identity.java @@ -25,80 +25,36 @@ * #L% */ -/** - *Identity interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public interface Identity extends Describable { - /** - *id.
- * - * @return a {@link java.lang.String} object. - */ String id(); - /** - *name.
- * - * @return a {@link java.lang.String} object. - */ + String name(); - /** - *description.
- * - * @return a {@link java.lang.String} object. - */ + String description(); - /** - *metadata.
- * - * @return a {@link com.pi4j.common.Metadata} object. - */ + Metadata metadata(); - /** - *getId.
- * - * @return a {@link java.lang.String} object. - */ - default String getId(){ + default String getId() { return id(); } - /** - *getName.
- * - * @return a {@link java.lang.String} object. - */ - default String getName(){ + default String getName() { return name(); } - /** - *getDescription.
- * - * @return a {@link java.lang.String} object. - */ - default String getDescription(){ + default String getDescription() { return description(); } - /** - *getMetadata.
- * - * @return a {@link com.pi4j.common.Metadata} object. - */ - default Metadata getMetadata(){ + default Metadata getMetadata() { return metadata(); } - /** {@inheritDoc} */ @Override default Descriptor describe() { return Descriptor.create() - .id(id()) - .name(name()) - .description(description()); + .id(id()) + .name(name()) + .description(description()); } } diff --git a/pi4j-core/src/main/java/com/pi4j/common/IdentityBase.java b/pi4j-core/src/main/java/com/pi4j/common/IdentityBase.java index 105d0272..fbbc3e2a 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/IdentityBase.java +++ b/pi4j-core/src/main/java/com/pi4j/common/IdentityBase.java @@ -10,7 +10,7 @@ * This file is part of the Pi4J project. More information about * this project can be found here: https://pi4j.com/ * ********************************************************************** - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -29,13 +29,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** - *Abstract IdentityBase class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - * @paramConstructor for IdentityBase.
- */ - public IdentityBase(){ + public IdentityBase() { this.id = getClass().getName(); this.name = this.getClass().getSimpleName(); this.description = this.getClass().getName(); } - /** - *Constructor for IdentityBase.
- * - * @param id a {@link java.lang.String} object. - */ - public IdentityBase(String id){ + public IdentityBase(String id) { this(); this.id = id; } - /** - *Constructor for IdentityBase.
- * - * @param id a {@link java.lang.String} object. - * @param name a {@link java.lang.String} object. - */ - public IdentityBase(String id, String name){ + public IdentityBase(String id, String name) { this(id); this.name = name; } - /** - *Constructor for IdentityBase.
- * - * @param id a {@link java.lang.String} object. - * @param name a {@link java.lang.String} object. - * @param description a {@link java.lang.String} object. - */ - public IdentityBase(String id, String name, String description){ + public IdentityBase(String id, String name, String description) { this(id, name); this.description = description; } - /** {@inheritDoc} */ @Override public String id() { return this.id; } - /** {@inheritDoc} */ @Override public String name() { return this.name; } - /** {@inheritDoc} */ @Override public String description() { return this.description; } - /** {@inheritDoc} */ @Override public Metadata metadata() { return this.metadata; diff --git a/pi4j-core/src/main/java/com/pi4j/common/Lifecycle.java b/pi4j-core/src/main/java/com/pi4j/common/Lifecycle.java index 18c2e9af..00897f6a 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/Lifecycle.java +++ b/pi4j-core/src/main/java/com/pi4j/common/Lifecycle.java @@ -29,23 +29,9 @@ import com.pi4j.exception.InitializeException; import com.pi4j.exception.ShutdownException; -/** - *Lifecycle interface.
- * - * @paraminitialize.
- * - * @param context a {@link com.pi4j.context.Context} object. - * - * @return a T object. - * * @throws com.pi4j.exception.InitializeException if an error occurs during initialization. */ T initialize(Context context) throws InitializeException; @@ -55,10 +41,6 @@ public interface LifecycleMetadata interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ -public interface Metadata { +public interface Metadata { // static Metadata create(){ // return new MetadataImpl(); @@ -54,143 +48,57 @@ public interface Metadata { // return create(key, value).description(description); // } - /** - *size.
- * - * @return a int. - */ int size(); - /** - *isEmpty.
- * - * @return a boolean. - */ + boolean isEmpty(); - /** - *contains.
- * - * @param key a {@link java.lang.String} object. - * @return a boolean. - */ + boolean contains(String key); - /** - *remove.
- * - * @param key a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ + Metadatum remove(String key); - /** - *put.
- * - * @param metadatum a {@link com.pi4j.common.Metadatum} object. - * @return a {@link com.pi4j.common.Metadata} object. - */ Metadata put(Metadatum metadatum); - /** - *clear.
- * - * @return a {@link com.pi4j.common.Metadata} object. - */ + Metadata clear(); - /** - *get.
- * - * @param key a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ + Metadatum get(String key); - /** - *all.
- * - * @return a {@link java.util.Collection} object. - */ + Collectionput.
- * - * @param c a {@link java.util.Collection} object. - * @return a {@link com.pi4j.common.Metadata} object. - */ - default Metadata put(Collection extends Metadatum> c){ - c.forEach((m)->{ + default Metadata put(Collection extends Metadatum> c) { + c.forEach((m) -> { put(m); }); return this; } - /** - *put.
- * - * @param metadata a {@link com.pi4j.common.Metadata} object. - * @return a {@link com.pi4j.common.Metadata} object. - */ - default Metadata put(Metadata metadata){ - metadata.all().forEach((m)->{ + default Metadata put(Metadata metadata) { + metadata.all().forEach((m) -> { put(m); }); return this; } - /** - *contains.
- * - * @param metadatum a {@link com.pi4j.common.Metadatum} object. - * @return a boolean. - */ - default boolean contains(Metadatum metadatum){ + default boolean contains(Metadatum metadatum) { return contains(metadatum.key()); } - /** - *getValue.
- * - * @param key a {@link java.lang.String} object. - * @return a {@link java.lang.Object} object. - */ - default Object getValue(String key){ + default Object getValue(String key) { return get(key).value(); } - /** - *put.
- * - * @param key a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadata} object. - */ - default Metadata put(String key){ + default Metadata put(String key) { return put(Metadatum.create(key)); } - /** - *put.
- * - * @param key a {@link java.lang.String} object. - * @param value a {@link java.lang.Object} object. - * @return a {@link com.pi4j.common.Metadata} object. - */ - default Metadata put(String key, Object value){ + + default Metadata put(String key, Object value) { return put(Metadatum.create(key, value)); } - /** - *put.
- * - * @param key a {@link java.lang.String} object. - * @param value a {@link java.lang.Object} object. - * @param description a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadata} object. - */ - default Metadata put(String key, Object value, String description){ + + default Metadata put(String key, Object value, String description) { return put(Metadatum.create(key, value, description)); } - /** - *create.
- * - * @return a {@link com.pi4j.common.Metadata} object. - */ - static Metadata create(){ + static Metadata create() { return new MetadataImpl(); } } diff --git a/pi4j-core/src/main/java/com/pi4j/common/Metadatum.java b/pi4j-core/src/main/java/com/pi4j/common/Metadatum.java index 07838094..e5cad995 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/Metadatum.java +++ b/pi4j-core/src/main/java/com/pi4j/common/Metadatum.java @@ -27,97 +27,36 @@ import com.pi4j.common.impl.MetadatumImpl; -/** - *Metadatum interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public interface Metadatum extends Describable { - /** - *key.
- * - * @param key a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ Metadatum key(String key); - /** - *value.
- * - * @param value a {@link java.lang.Object} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ + Metadatum value(Object value); - /** - *description.
- * - * @param description a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ + Metadatum description(String description); - /** - *key.
- * - * @return a {@link java.lang.String} object. - */ + String key(); - /** - *value.
- * - * @return a {@link java.lang.Object} object. - */ + Object value(); - /** - *description.
- * - * @return a {@link java.lang.String} object. - */ + String description(); - /** - *create.
- * - * @return a {@link com.pi4j.common.Metadatum} object. - */ - static Metadatum create(){ + static Metadatum create() { return new MetadatumImpl(); } - /** - *create.
- * - * @param key a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ - static Metadatum create(String key){ + static Metadatum create(String key) { return create().key(key); } - /** - *create.
- * - * @param key a {@link java.lang.String} object. - * @param value a {@link java.lang.Object} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ - static Metadatum create(String key, Object value){ + static Metadatum create(String key, Object value) { return create(key).value(value); } - /** - *create.
- * - * @param key a {@link java.lang.String} object. - * @param value a {@link java.lang.Object} object. - * @param description a {@link java.lang.String} object. - * @return a {@link com.pi4j.common.Metadatum} object. - */ - static Metadatum create(String key, Object value, String description){ + static Metadatum create(String key, Object value, String description) { return create(key, value).description(description); } - /** {@inheritDoc} */ @Override default Descriptor describe() { return Descriptor.create().name(key()).description(description()).value(value()); diff --git a/pi4j-core/src/main/java/com/pi4j/common/impl/DescriptorImpl.java b/pi4j-core/src/main/java/com/pi4j/common/impl/DescriptorImpl.java index 26b55690..9a7c7ab2 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/impl/DescriptorImpl.java +++ b/pi4j-core/src/main/java/com/pi4j/common/impl/DescriptorImpl.java @@ -34,12 +34,6 @@ import java.util.Set; import java.util.stream.Collectors; -/** - *DescriptorImpl class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class DescriptorImpl implements Descriptor { private SetConstructor for DescriptorImpl.
- */ public DescriptorImpl(){ this.parent = null; } - /** {@inheritDoc} */ @Override public Descriptor id(String id) { this.id = id; return this; } - /** {@inheritDoc} */ @Override public Descriptor name(String name) { this.name = name; return this; } - /** {@inheritDoc} */ @Override public Descriptor description(String description) { this.description = description; return this; } - /** {@inheritDoc} */ @Override public Descriptor category(String category) { this.category = category; return this; } - /** {@inheritDoc} */ @Override public Descriptor quantity(Integer quantity) { this.quantity = quantity; return this; } - /** {@inheritDoc} */ @Override public Descriptor value(Object value) { this.value = value; return this; } - /** {@inheritDoc} */ @Override public Descriptor type(Class type) { this.type = type; return this; } - /** {@inheritDoc} */ @Override public Descriptor parent(Descriptor parent) { this.parent = parent; return this; } - /** {@inheritDoc} */ @Override public String id() { return this.id; } - /** {@inheritDoc} */ @Override public String name() { return this.name; } - /** {@inheritDoc} */ @Override public String description() { return this.description; } - /** {@inheritDoc} */ @Override public String category() { return this.category; } - /** {@inheritDoc} */ @Override public Integer quantity() { return this.quantity; } - /** {@inheritDoc} */ @Override public Object value() { return this.value; } - /** {@inheritDoc} */ @Override public Class type() { return this.type; } - /** {@inheritDoc} */ @Override public Descriptor parent() { return this.parent; } - /** {@inheritDoc} */ @Override public Descriptor add(Descriptor descriptor) { if(descriptor != null) { @@ -173,34 +147,18 @@ public Descriptor add(Descriptor descriptor) { return this; } - /** - *size.
- * - * @return a int. - */ public int size(){ return children.size(); } - /** - *isEmpty.
- * - * @return a boolean. - */ public boolean isEmpty(){ return children.isEmpty(); } - /** - *isNotEmpty.
- * - * @return a boolean. - */ public boolean isNotEmpty(){ return !children.isEmpty(); } - /** {@inheritDoc} */ public void print(PrintStream stream){ print(stream, "", new ArrayList<>()); } diff --git a/pi4j-core/src/main/java/com/pi4j/common/impl/MetadataImpl.java b/pi4j-core/src/main/java/com/pi4j/common/impl/MetadataImpl.java index 5e735739..5afc1dd8 100644 --- a/pi4j-core/src/main/java/com/pi4j/common/impl/MetadataImpl.java +++ b/pi4j-core/src/main/java/com/pi4j/common/impl/MetadataImpl.java @@ -33,61 +33,47 @@ import java.util.LinkedHashMap; import java.util.Map; -/** - *MetadataImpl class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class MetadataImpl implements Metadata { private MapMetadatumImpl class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class MetadatumImpl implements Metadatum { private String key; private Object value; private String description; - /** {@inheritDoc} */ @Override public MetadatumImpl key(String key) { this.key = key; return this; } - /** {@inheritDoc} */ @Override public MetadatumImpl value(Object value) { this.value = value; return this; } - /** {@inheritDoc} */ @Override public MetadatumImpl description(String description) { this.description = description; return this; } - /** {@inheritDoc} */ @Override public String key() { return this.key; } - /** {@inheritDoc} */ @Override public Object value() { return this.value; } - /** {@inheritDoc} */ @Override public String description() { return this.description; } - /** {@inheritDoc} */ @Override public String toString(){ return key() + " = " + value().toString(); diff --git a/pi4j-core/src/main/java/com/pi4j/config/BcmConfig.java b/pi4j-core/src/main/java/com/pi4j/config/BcmConfig.java index 7a0cf82e..8165bfd9 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/BcmConfig.java +++ b/pi4j-core/src/main/java/com/pi4j/config/BcmConfig.java @@ -29,8 +29,6 @@ *BcmConfig interface.
* * @param
* Since "address" has lead to many confusions while configuring IOs,
@@ -60,9 +55,6 @@ public interface BcmConfig
* Since "address" has lead to many confusions while configuring IOs, @@ -79,18 +71,8 @@ default Integer getAddress() { */ String BCM_KEY = "bcm"; - /** - *
pin.
- * - * @return a {@link Integer} object. - */ Integer bcm(); - /** - *getBcm.
- * - * @return a {@link Integer} object. - */ default Integer getBcm() { return this.bcm(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/BcmConfigBuilder.java b/pi4j-core/src/main/java/com/pi4j/config/BcmConfigBuilder.java index 26b17894..1b52bde5 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/BcmConfigBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/config/BcmConfigBuilder.java @@ -30,15 +30,9 @@ * * @paramaddress.
- * - * @param address a {@link java.lang.Integer} object. - * @return a BUILDER_TYPE object. * @deprecated use {@link #bcm(Integer)} instead. *
*/
@@ -47,9 +41,6 @@ public interface BcmConfigBuilder pin defined by BCM number. Builder interface. build. BusConfig interface.
getBus.
- * - * @return a {@link Integer} object. - */ default Integer getBus() { return this.bus(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/BusConfigBuilder.java b/pi4j-core/src/main/java/com/pi4j/config/BusConfigBuilder.java index 673fbf9e..ecec4309 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/BusConfigBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/config/BusConfigBuilder.java @@ -30,15 +30,7 @@ * * @parambus.
- * - * @param bus a {@link Integer} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE bus(Integer bus); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/ChannelConfig.java b/pi4j-core/src/main/java/com/pi4j/config/ChannelConfig.java index e12880de..4e88dfa2 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/ChannelConfig.java +++ b/pi4j-core/src/main/java/com/pi4j/config/ChannelConfig.java @@ -29,8 +29,6 @@ *ChannelConfig interface.
* * @paramgetChannel.
- * - * @return a {@link Integer} object. - */ default Integer getChannel() { return this.channel(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/ChannelConfigBuilder.java b/pi4j-core/src/main/java/com/pi4j/config/ChannelConfigBuilder.java index a828a9ed..3507db39 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/ChannelConfigBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/config/ChannelConfigBuilder.java @@ -30,15 +30,7 @@ * * @paramchannel.
- * - * @param channel a {@link Integer} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE channel(Integer channel); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/ChipConfig.java b/pi4j-core/src/main/java/com/pi4j/config/ChipConfig.java index 86ff1609..5bb29f61 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/ChipConfig.java +++ b/pi4j-core/src/main/java/com/pi4j/config/ChipConfig.java @@ -29,8 +29,6 @@ *ChipConfig interface.
* * @paramgetChip.
- * - * @return a {@link Integer} object. - */ default Integer getChip() { return this.chip(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/ChipConfigBuilder.java b/pi4j-core/src/main/java/com/pi4j/config/ChipConfigBuilder.java index 94d2a9c2..977dbe6b 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/ChipConfigBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/config/ChipConfigBuilder.java @@ -30,15 +30,7 @@ * * @paramchip.
- * - * @param chip a {@link Integer} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE chip(Integer chip); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/Config.java b/pi4j-core/src/main/java/com/pi4j/config/Config.java index 54095ba2..4e3ba3c0 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/Config.java +++ b/pi4j-core/src/main/java/com/pi4j/config/Config.java @@ -31,8 +31,6 @@ *Config interface.
* * @paramid.
- * - * @return a {@link java.lang.String} object. - */ String id(); - /** - *name.
- * - * @return a {@link java.lang.String} object. - */ String name(); - /** - *description.
- * - * @return a {@link java.lang.String} object. - */ String description(); - /** - *validate.
- */ void validate(); - /** - *getId.
- * - * @return a {@link java.lang.String} object. - */ default String getId() { return this.id(); } - /** - *getName.
- * - * @return a {@link java.lang.String} object. - */ default String getName() { return this.name(); } - /** - *getDescription.
- * - * @return a {@link java.lang.String} object. - */ default String getDescription() { return this.description(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/ConfigBase.java b/pi4j-core/src/main/java/com/pi4j/config/ConfigBase.java index 26913e04..781b74fd 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/ConfigBase.java +++ b/pi4j-core/src/main/java/com/pi4j/config/ConfigBase.java @@ -33,11 +33,7 @@ import java.util.Map; /** - *ConfigBase class.
- * * @paramConfigBuilder interface.
* - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id * @paramid.
- * - * @param id a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE id(String id); String id(); - /** - *name.
- * - * @param name a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE name(String name); - /** - *description.
- * - * @param description a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE description(String description); - /** - *load.
- * - * @param properties a {@link java.util.Map} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE load(Mapload.
- * - * @param properties a {@link java.util.Properties} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE load(Properties properties); - /** - *load.
- * - * @param properties a {@link java.util.Map} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE load(Mapload.
- * - * @param properties a {@link java.util.Properties} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE load(Properties properties, String prefixFilter); /** - *load.
- * - * @param stream a {@link java.io.InputStream} object. - * @return a BUILDER_TYPE object. * @throws java.io.IOException if an error occurs accessing {@code stream}. */ BUILDER_TYPE load(InputStream stream) throws IOException; /** - *load.
- * - * @param stream a {@link java.io.InputStream} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. * @throws java.io.IOException if an error occurs accessing {@code stream}. */ BUILDER_TYPE load(InputStream stream, String prefixFilter) throws IOException; /** - *load.
- * - * @param reader a {@link java.io.Reader} object. - * @return a BUILDER_TYPE object. * @throws java.io.IOException if an error occurs accessing {@code reader}. */ BUILDER_TYPE load(Reader reader) throws IOException; /** - *load.
- * - * @param reader a {@link java.io.Reader} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. * @throws java.io.IOException if an error occurs accessing {@code reader}. */ BUILDER_TYPE load(Reader reader, String prefixFilter) throws IOException; /** - *load.
- * - * @param file a {@link java.io.File} object. - * @return a BUILDER_TYPE object. * @throws java.io.IOException if an error occurs accessing {@code file}. */ BUILDER_TYPE load(File file) throws IOException; /** - *load.
- * - * @param file a {@link java.io.File} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a BUILDER_TYPE object. * @throws java.io.IOException if an error occurs accessing {@code file}. */ BUILDER_TYPE load(File file, String prefixFilter) throws IOException; diff --git a/pi4j-core/src/main/java/com/pi4j/config/DeviceConfig.java b/pi4j-core/src/main/java/com/pi4j/config/DeviceConfig.java index f6dc9f18..94a3d752 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/DeviceConfig.java +++ b/pi4j-core/src/main/java/com/pi4j/config/DeviceConfig.java @@ -29,8 +29,6 @@ *DeviceConfig interface.
* * @paramgetDevice.
- * - * @return a {@link java.lang.Integer} object. - */ default Integer getDevice() { return this.device(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/DeviceConfigBuilder.java b/pi4j-core/src/main/java/com/pi4j/config/DeviceConfigBuilder.java index 97cab376..decf25fc 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/DeviceConfigBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/config/DeviceConfigBuilder.java @@ -30,15 +30,7 @@ * * @paramdevice.
- * - * @param device a {@link java.lang.Integer} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE device(Integer device); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/PortConfig.java b/pi4j-core/src/main/java/com/pi4j/config/PortConfig.java index 5d1df5a1..2ea7efd4 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/PortConfig.java +++ b/pi4j-core/src/main/java/com/pi4j/config/PortConfig.java @@ -29,8 +29,6 @@ *PortConfig interface.
* * @paramgetPort.
- * - * @return a {@link String} object. - */ default String getPort() { return this.port(); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/PortConfigBuilder.java b/pi4j-core/src/main/java/com/pi4j/config/PortConfigBuilder.java index 51e822c6..86ed0d22 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/PortConfigBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/config/PortConfigBuilder.java @@ -30,15 +30,7 @@ * * @paramport.
- * - * @param port a {@link String} object. - * @return a BUILDER_TYPE object. - */ BUILDER_TYPE port(String port); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigEmptyException.java b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigEmptyException.java index 74e99be6..d3da4002 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigEmptyException.java +++ b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigEmptyException.java @@ -32,9 +32,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class ConfigEmptyException extends ConfigException { @@ -48,11 +45,6 @@ public ConfigEmptyException(){ super(MESSAGE); } - /** - *Constructor for ConfigEmptyException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public ConfigEmptyException(Throwable cause){ super(MESSAGE, cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigException.java b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigException.java index b038f732..c264c132 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigException.java +++ b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigException.java @@ -32,9 +32,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class ConfigException extends RuntimeException { @@ -47,21 +44,10 @@ public ConfigException(String message){ super(message); } - /** - *Constructor for ConfigException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public ConfigException(Throwable cause){ super(cause); } - /** - *Constructor for ConfigException.
- * - * @param message a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. - */ public ConfigException(String message, Throwable cause){ super(message,cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingPrefixException.java b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingPrefixException.java index a3d2c3be..57ed0dc7 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingPrefixException.java +++ b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingPrefixException.java @@ -32,9 +32,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class ConfigMissingPrefixException extends ConfigException { @@ -48,11 +45,6 @@ public ConfigMissingPrefixException(){ super(MESSAGE); } - /** - *Constructor for ConfigMissingPrefixException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public ConfigMissingPrefixException(Throwable cause){ super(MESSAGE, cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingRequiredKeyException.java b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingRequiredKeyException.java index efdb2a52..22f4d33f 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingRequiredKeyException.java +++ b/pi4j-core/src/main/java/com/pi4j/config/exception/ConfigMissingRequiredKeyException.java @@ -32,9 +32,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class ConfigMissingRequiredKeyException extends ConfigException { @@ -43,19 +40,11 @@ public class ConfigMissingRequiredKeyException extends ConfigException { /** * Default Constructor - * - * @param key a {@link java.lang.String} object. */ public ConfigMissingRequiredKeyException(String key){ super(MESSAGE + key); } - /** - *Constructor for ConfigMissingRequiredKeyException.
- * - * @param key a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. - */ public ConfigMissingRequiredKeyException(String key, Throwable cause){ super(MESSAGE + key, cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBase.java b/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBase.java index 780122d6..58e70f20 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBase.java +++ b/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBase.java @@ -36,8 +36,6 @@ *Abstract AddressConfigBase class.
* * @paramConstructor for BcmConfigBase.
- * - * @param bcm a {@link java.lang.Integer} object. - */ protected BcmConfigBase(Integer bcm) { super(); this.bcm = bcm; @@ -65,8 +58,6 @@ protected BcmConfigBase(Integer bcm) { /** * PRIVATE CONSTRUCTOR - * - * @param properties a {@link java.util.Map} object. */ protected BcmConfigBase(Mapaddress.
- * - * @return a {@link java.lang.Integer} object. - */ public Integer address() { return this.bcm; } - /** - *bcm.
- * - * @return a {@link java.lang.Integer} object. - */ public Integer bcm() { return this.bcm; } diff --git a/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBuilderBase.java b/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBuilderBase.java index fbcc738c..ff0d68f3 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBuilderBase.java +++ b/pi4j-core/src/main/java/com/pi4j/config/impl/BcmConfigBuilderBase.java @@ -35,8 +35,6 @@ * * @paramAbstract DeviceConfigBase class.
* * @paramdevice.
- * - * @return a {@link java.lang.Integer} object. - */ public Integer device() { return this.device; } diff --git a/pi4j-core/src/main/java/com/pi4j/config/impl/DeviceConfigBuilderBase.java b/pi4j-core/src/main/java/com/pi4j/config/impl/DeviceConfigBuilderBase.java index 2a9bb687..74acc1e7 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/impl/DeviceConfigBuilderBase.java +++ b/pi4j-core/src/main/java/com/pi4j/config/impl/DeviceConfigBuilderBase.java @@ -35,8 +35,6 @@ * * @paramConstructor for PortConfigBase.
- * - * @param port a {@link String} object. - */ protected PortConfigBase(String port) { super(); this.port = port; @@ -65,8 +58,6 @@ protected PortConfigBase(String port) { /** * PRIVATE CONSTRUCTOR - * - * @param properties a {@link Map} object. */ protected PortConfigBase(Mapport.
- * - * @return a {@link String} object. - */ public String port() { return this.port; } diff --git a/pi4j-core/src/main/java/com/pi4j/config/impl/PortConfigBuilderBase.java b/pi4j-core/src/main/java/com/pi4j/config/impl/PortConfigBuilderBase.java index 25d32f02..1b4125cb 100644 --- a/pi4j-core/src/main/java/com/pi4j/config/impl/PortConfigBuilderBase.java +++ b/pi4j-core/src/main/java/com/pi4j/config/impl/PortConfigBuilderBase.java @@ -36,8 +36,6 @@ * * @paramContext interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface Context extends Describable, IOCreator, ProviderProvider, InitializedEventProducerconfig.
- * - * @return a {@link com.pi4j.context.ContextConfig} object. - */ ContextConfig config(); - /** - *providers.
- * - * @return a {@link com.pi4j.provider.Providers} object. - */ Providers providers(); - /** - *registry.
- * - * @return a {@link com.pi4j.registry.Registry} object. - */ Registry registry(); /** @@ -91,9 +73,6 @@ public interface Context extends Describable, IOCreator, ProviderProvider, Initi Future> submitTask(Runnable task); /** - *shutdown.
- * - * @return a {@link com.pi4j.context.Context} object. * @throws com.pi4j.exception.ShutdownException if an error occurs during shutdown. */ Context shutdown() throws ShutdownException; @@ -113,9 +92,6 @@ public interface Context extends Describable, IOCreator, ProviderProvider, Initi // ------------------------------------------------------------------------ /** - *provider.
- * - * @param providerId a {@link java.lang.String} object. * @paramprovider.
- * - * @param providerId a {@link java.lang.String} object. - * @param providerClass a T object. * @paramHas providers.
* - * @param providerId a {@link java.lang.String} object. * @return */ default boolean hasProvider(String providerId) { @@ -157,7 +128,6 @@ default boolean hasProvider(String providerId) { /** *Has providers.
* - * @param ioType a {@link com.pi4j.io.IOType} object. * @paramHas providers.
* - * @param providerClass a {@link java.lang.Class} object. * @paramprovider.
- * - * @param providerClass a {@link java.lang.Class} object. * @paramprovider.
- * - * @param ioType a {@link com.pi4j.io.IOType} object. * @paramdescribe.
- * - * @return a {@link com.pi4j.common.Descriptor} object. - */ default Descriptor describe() { Descriptor descriptor = Descriptor.create().category("CONTEXT").name("Runtime Context").type(this.getClass()); diff --git a/pi4j-core/src/main/java/com/pi4j/context/ContextBuilder.java b/pi4j-core/src/main/java/com/pi4j/context/ContextBuilder.java index 986902d7..8d2daa58 100644 --- a/pi4j-core/src/main/java/com/pi4j/context/ContextBuilder.java +++ b/pi4j-core/src/main/java/com/pi4j/context/ContextBuilder.java @@ -38,99 +38,33 @@ /** *ContextBuilder interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface ContextBuilder extends BuildernewInstance.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ static ContextBuilder newInstance(){ return DefaultContextBuilder.newInstance(); } - /** - *add.
- * - * @param provider a {@link com.pi4j.provider.Provider} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder add(Provider ... provider); - /** - *defaultPlatform.
- * - * @return a {@link java.lang.String} object. - */ String defaultPlatform(); - /** - *defaultPlatform.
- * - * @param platformId a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder defaultPlatform(String platformId); - /** - *autoDetectMockPlugins.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder autoDetectMockPlugins(); - /** - *autoDetectPlatforms.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder autoDetectPlatforms(); - /** - *noAutoDetectPlatforms.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder noAutoDetectPlatforms(); - /** - *autoDetectProviders.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder autoDetectProviders(); - /** - *noAutoDetectProviders.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder noAutoDetectProviders(); - /** - *autoInject.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder autoInject(); - /** - *noAutoInject.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder noAutoInject(); - /** - *setAutoInject.
- * - * @param autoInject a boolean. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder setAutoInject(boolean autoInject){ if(autoInject) return autoInject(); @@ -138,27 +72,10 @@ default ContextBuilder setAutoInject(boolean autoInject){ return noAutoInject(); } - /** - *enableShutdownHook.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder enableShutdownHook(); - /** - *disableShutdownHook.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder disableShutdownHook(); - /** - *setShutdownHook.
- * - * @param enableShutdownHook a boolean. - * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder setShutdownHook(boolean enableShutdownHook) { if (enableShutdownHook) return enableShutdownHook(); @@ -166,19 +83,8 @@ default ContextBuilder setShutdownHook(boolean enableShutdownHook) { return disableShutdownHook(); } - /** - *toConfig.
- * - * @return a {@link com.pi4j.context.ContextConfig} object. - */ ContextConfig toConfig(); - /** - *setAutoDetect.
- * - * @param autoDetect a boolean. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder setAutoDetect(boolean autoDetect){ if(autoDetect) return autoDetect(); @@ -186,116 +92,48 @@ default ContextBuilder setAutoDetect(boolean autoDetect){ return noAutoDetect(); } - /** - *autoDetect.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder autoDetect(){ // auto detect all extensibility modules in the classpath return autoDetectPlatforms(). autoDetectProviders(); } - /** - *noAutoDetect.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder noAutoDetect(){ // do not auto detect all extensibility modules in the classpath return noAutoDetectPlatforms(). noAutoDetectProviders(); } - /** - *property.
- * - * @param key a {@link java.lang.String} object. - * @param value a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder property(String key, String value); - /** - *property.
- * - * @param value a {@link java.util.Map.Entry} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder property(Map.Entryproperties.
- * - * @param values a {@link java.util.Map} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder properties(Mapproperties.
- * - * @param properties a {@link java.util.Map} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder properties(Mapproperties.
- * - * @param properties a {@link java.util.Properties} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ ContextBuilder properties(Properties properties, String prefixFilter); /** - *properties.
- * - * @param stream a {@link java.io.InputStream} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code stream}. */ ContextBuilder properties(InputStream stream, String prefixFilter) throws IOException; /** - *properties.
- * - * @param reader a {@link java.io.Reader} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code reader}. */ ContextBuilder properties(Reader reader, String prefixFilter) throws IOException; /** - *properties.
- * - * @param file a {@link java.io.File} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code file}. */ ContextBuilder properties(File file, String prefixFilter) throws IOException; - /** - *properties.
- * - * @param properties a {@link java.util.Properties} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder properties(Properties properties){ return properties(properties, null); } /** - *properties.
- * - * @param stream a {@link java.io.InputStream} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code stream}. */ default ContextBuilder properties(InputStream stream) throws IOException { @@ -303,10 +141,6 @@ default ContextBuilder properties(InputStream stream) throws IOException { } /** - *properties.
- * - * @param reader a {@link java.io.Reader} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code reader}. */ default ContextBuilder properties(Reader reader) throws IOException { @@ -314,84 +148,37 @@ default ContextBuilder properties(Reader reader) throws IOException { } /** - *properties.
- * - * @param file a {@link java.io.File} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code file}. */ default ContextBuilder properties(File file) throws IOException { return properties(file, null); } - /** - *addProperty.
- * - * @param key a {@link java.lang.String} object. - * @param value a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder addProperty(String key, String value){ return property(key, value); } - /** - *addProperty.
- * - * @param value a {@link java.util.Map.Entry} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder addProperty(Map.EntryaddProperties.
- * - * @param properties a {@link java.util.Properties} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder addProperties(Properties properties, String prefixFilter){ return properties(properties, prefixFilter); } - /** - *addProperties.
- * - * @param properties a {@link java.util.Properties} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder addProperties(Properties properties){ return properties(properties, null); } - /** - *addProperties.
- * - * @param properties a {@link java.util.Map} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder addProperties(MapaddProperties.
- * - * @param properties a {@link java.util.Map} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder addProperties(MapaddProperties.
- * - * @param stream a {@link java.io.InputStream} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code stream}. */ default ContextBuilder addProperties(InputStream stream) throws IOException{ @@ -399,11 +186,6 @@ default ContextBuilder addProperties(InputStream stream) throws IOException{ } /** - *addProperties.
- * - * @param stream a {@link java.io.InputStream} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code stream}. */ default ContextBuilder addProperties(InputStream stream, String prefixFilter) throws IOException{ @@ -411,10 +193,6 @@ default ContextBuilder addProperties(InputStream stream, String prefixFilter) th } /** - *addProperties.
- * - * @param reader a {@link java.io.Reader} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code reader}. */ default ContextBuilder addProperties(Reader reader) throws IOException{ @@ -422,11 +200,6 @@ default ContextBuilder addProperties(Reader reader) throws IOException{ } /** - *addProperties.
- * - * @param reader a {@link java.io.Reader} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code reader}. */ default ContextBuilder addProperties(Reader reader, String prefixFilter) throws IOException{ @@ -434,10 +207,6 @@ default ContextBuilder addProperties(Reader reader, String prefixFilter) throws } /** - *addProperties.
- * - * @param file a {@link java.io.File} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code file}. */ default ContextBuilder addProperties(File file) throws IOException{ @@ -445,34 +214,16 @@ default ContextBuilder addProperties(File file) throws IOException{ } /** - *addProperties.
- * - * @param file a {@link java.io.File} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. * @throws java.io.IOException if an error occurs accessing {@code file}. */ default ContextBuilder addProperties(File file, String prefixFilter) throws IOException{ return properties(file, prefixFilter); } - /** - *add.
- * - * @param properties a {@link java.util.Properties} object. - * @param prefixFilter a {@link java.lang.String} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder add(Properties properties, String prefixFilter){ return properties(properties, prefixFilter); } - /** - *add.
- * - * @param properties a {@link java.util.Properties} object. - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ default ContextBuilder add(Properties properties){ return properties(properties, null); } @@ -481,7 +232,6 @@ default ContextBuilder add(Properties properties){ * Sets the GPIO chip name to be used by the Context. * * @param chipName The name of the GPIO chip (e.g., "gpiochip0"). - * @return a {@link com.pi4j.context.ContextBuilder} object. */ ContextBuilder setGpioChipName(String chipName); } diff --git a/pi4j-core/src/main/java/com/pi4j/context/ContextConfig.java b/pi4j-core/src/main/java/com/pi4j/context/ContextConfig.java index 953604d0..90caedfe 100644 --- a/pi4j-core/src/main/java/com/pi4j/context/ContextConfig.java +++ b/pi4j-core/src/main/java/com/pi4j/context/ContextConfig.java @@ -32,123 +32,35 @@ /** *ContextConfig interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface ContextConfig { - /** - *autoDetectMockPlugins.
- * - * @return a boolean. - */ boolean autoDetectMockPlugins(); - /** - *autoDetectPlatforms.
- * - * @return a boolean. - */ boolean autoDetectPlatforms(); - /** - *getAutoDetectPlatforms.
- * - * @return a boolean. - */ default boolean getAutoDetectPlatforms() { return autoDetectPlatforms(); }; - /** - *isAutoDetectPlatforms.
- * - * @return a boolean. - */ default boolean isAutoDetectPlatforms() { return autoDetectPlatforms(); }; - /** - *autoInject.
- * - * @return a boolean. - */ boolean autoInject(); - /** - *enableShutdownHook.
- * - * @return a boolean. - */ boolean enableShutdownHook(); - /** - *getAutoInject.
- * - * @return a boolean. - */ default boolean getAutoInject() { return autoInject(); }; - /** - *isAutoInject.
- * - * @return a boolean. - */ default boolean isAutoInject() { return autoInject(); }; - /** - *defaultPlatform.
- * - * @return a {@link java.lang.String} object. - */ String defaultPlatform(); - /** - *getDefaultPlatform.
- * - * @return a {@link java.lang.String} object. - */ default String getDefaultPlatform(){ return defaultPlatform(); } - /** - *hasDefaultPlatform.
- * - * @return a boolean. - */ default boolean hasDefaultPlatform(){ return getDefaultPlatform() != null;}; // ************************************************** // PROVIDERS // ************************************************** - /** - *providers.
- * - * @return a {@link java.util.Collection} object. - */ CollectiongetProviders.
- * - * @return a {@link java.util.Collection} object. - */ default CollectionautoDetectProviders.
- * - * @return a boolean. - */ boolean autoDetectProviders(); - /** - *getAutoDetectProviders.
- * - * @return a boolean. - */ default boolean getAutoDetectProviders() { return autoDetectProviders(); }; - /** - *isAutoDetectProviders.
- * - * @return a boolean. - */ default boolean isAutoDetectProviders() { return autoDetectProviders(); }; // ************************************************** // PROPERTIES // ************************************************** - /** - *properties.
- * - * @return a {@link java.util.Map} object. - */ MapDefaultContext class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class DefaultContext implements Context { private final Logger logger = LoggerFactory.getLogger(this.getClass()); @@ -76,12 +70,6 @@ public class DefaultContext implements Context { private volatile boolean isShutdown = false; - /** - *newInstance.
- * - * @param config a {@link com.pi4j.context.ContextConfig} object. - * @return a {@link com.pi4j.context.Context} object. - */ public static Context newInstance(ContextConfig config) { return new DefaultContext(config); } @@ -222,29 +210,23 @@ private void addProvider(Provider provider, MapDefaultContextBuilder class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class DefaultContextBuilder implements ContextBuilder { protected Logger logger = LoggerFactory.getLogger(DefaultContextBuilder.class); @@ -75,16 +69,10 @@ private DefaultContextBuilder(){ // forbid object construction } - /** - *newInstance.
- * - * @return a {@link com.pi4j.context.ContextBuilder} object. - */ public static ContextBuilder newInstance(){ return new DefaultContextBuilder(); } - /** {@inheritDoc} */ @Override public ContextBuilder add(Provider... provider) { if(provider != null && provider.length > 0) @@ -92,13 +80,11 @@ public ContextBuilder add(Provider... provider) { return this; } - /** {@inheritDoc} */ @Override public String defaultPlatform() { return this.defaultPlatformId; } - /** {@inheritDoc} */ @Override public ContextBuilder defaultPlatform(String platformId) { this.defaultPlatformId = platformId; @@ -110,70 +96,60 @@ public ContextBuilder autoDetectMockPlugins() { return this; } - /** {@inheritDoc} */ @Override public ContextBuilder autoDetectPlatforms() { this.autoDetectPlatforms = true; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder noAutoDetectPlatforms() { this.autoDetectPlatforms = false; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder autoDetectProviders() { this.autoDetectProviders = true; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder noAutoDetectProviders() { this.autoDetectProviders = false; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder autoInject() { this.autoInject = true; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder noAutoInject() { this.autoInject = false; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder enableShutdownHook() { this.enableShutdownHook = true; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder disableShutdownHook() { this.enableShutdownHook = false; return this; } - /** {@inheritDoc} */ @Override public ContextBuilder property(String key, String value){ this.properties.put(key, value); return this; } - /** {@inheritDoc} */ @Override public ContextBuilder property(Map.Entry*
* - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id * @see http://www.pi4j.com/ */ public class MutableProviders implements Providers { @@ -74,41 +71,26 @@ public class MutableProviders implements Providers { private ProviderGroupEvent interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface Event { // MARKER INTERFACE diff --git a/pi4j-core/src/main/java/com/pi4j/event/Listener.java b/pi4j-core/src/main/java/com/pi4j/event/Listener.java index 0e9358b5..c8690449 100644 --- a/pi4j-core/src/main/java/com/pi4j/event/Listener.java +++ b/pi4j-core/src/main/java/com/pi4j/event/Listener.java @@ -27,10 +27,7 @@ /** *Listener interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface Listener { - // MARKET INTERFACE + // MARKER INTERFACE } diff --git a/pi4j-core/src/main/java/com/pi4j/exception/InitializeException.java b/pi4j-core/src/main/java/com/pi4j/exception/InitializeException.java index 0782af99..a62d5960 100644 --- a/pi4j-core/src/main/java/com/pi4j/exception/InitializeException.java +++ b/pi4j-core/src/main/java/com/pi4j/exception/InitializeException.java @@ -32,16 +32,11 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class InitializeException extends Pi4JException { /** * Default Constructor - * - * @param message a {@link java.lang.String} object. */ public InitializeException(String message){ super(message); @@ -49,8 +44,6 @@ public InitializeException(String message){ /** * Default Constructor - * - * @param cause a {@link java.lang.Throwable} object. */ public InitializeException(Throwable cause){ super(cause.getMessage(), cause); @@ -58,9 +51,6 @@ public InitializeException(Throwable cause){ /** * Default Constructor - * - * @param message a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. */ public InitializeException(String message, Throwable cause){ super(message, cause); diff --git a/pi4j-core/src/main/java/com/pi4j/exception/LifecycleException.java b/pi4j-core/src/main/java/com/pi4j/exception/LifecycleException.java index b118f25c..1e6e6111 100644 --- a/pi4j-core/src/main/java/com/pi4j/exception/LifecycleException.java +++ b/pi4j-core/src/main/java/com/pi4j/exception/LifecycleException.java @@ -32,9 +32,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class LifecycleException extends Pi4JException { @@ -47,21 +44,10 @@ public LifecycleException(String message){ super(message); } - /** - *Constructor for LifecycleException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public LifecycleException(Throwable cause){ super(cause); } - /** - *Constructor for LifecycleException.
- * - * @param message a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. - */ public LifecycleException(String message, Throwable cause){ super(message,cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/exception/Pi4JException.java b/pi4j-core/src/main/java/com/pi4j/exception/Pi4JException.java index 8a9c0129..86536d4e 100644 --- a/pi4j-core/src/main/java/com/pi4j/exception/Pi4JException.java +++ b/pi4j-core/src/main/java/com/pi4j/exception/Pi4JException.java @@ -31,9 +31,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class Pi4JException extends RuntimeException { @@ -46,21 +43,10 @@ public Pi4JException(String message){ super(message); } - /** - *Constructor for Pi4JException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public Pi4JException(Throwable cause){ super(cause); } - /** - *Constructor for Pi4JException.
- * - * @param message a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. - */ public Pi4JException(String message, Throwable cause){ super(message,cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/exception/ShutdownException.java b/pi4j-core/src/main/java/com/pi4j/exception/ShutdownException.java index 26077cdf..fc552837 100644 --- a/pi4j-core/src/main/java/com/pi4j/exception/ShutdownException.java +++ b/pi4j-core/src/main/java/com/pi4j/exception/ShutdownException.java @@ -32,9 +32,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class ShutdownException extends LifecycleException { @@ -47,21 +44,10 @@ public ShutdownException(String message){ super(message); } - /** - *Constructor for ShutdownException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public ShutdownException(Throwable cause){ super(cause); } - /** - *Constructor for ShutdownException.
- * - * @param message a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. - */ public ShutdownException(String message, Throwable cause){ super(message,cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/extension/Extension.java b/pi4j-core/src/main/java/com/pi4j/extension/Extension.java index 1637be0a..fda7213c 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/Extension.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/Extension.java @@ -32,17 +32,10 @@ /** *Extension interface.
* - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id * @paramdescribe.
- * - * @return a {@link com.pi4j.common.Descriptor} object. - */ default Descriptor describe() { return Descriptor.create() .id(this.id()) diff --git a/pi4j-core/src/main/java/com/pi4j/extension/ExtensionBase.java b/pi4j-core/src/main/java/com/pi4j/extension/ExtensionBase.java index ed17692c..fb1aaf9d 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/ExtensionBase.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/ExtensionBase.java @@ -30,45 +30,22 @@ /** *Abstract ExtensionBase class.
* - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id * @paramConstructor for ExtensionBase.
- */ public ExtensionBase(){ super(); } - /** - *Constructor for ExtensionBase.
- * - * @param id a {@link java.lang.String} object. - */ public ExtensionBase(String id){ super(id); } - /** - *Constructor for ExtensionBase.
- * - * @param id a {@link java.lang.String} object. - * @param name a {@link java.lang.String} object. - */ public ExtensionBase(String id, String name){ super(id, name); } - /** - *Constructor for ExtensionBase.
- * - * @param id a {@link java.lang.String} object. - * @param name a {@link java.lang.String} object. - * @param description a {@link java.lang.String} object. - */ public ExtensionBase(String id, String name, String description){ super(id, name, description); } diff --git a/pi4j-core/src/main/java/com/pi4j/extension/Plugin.java b/pi4j-core/src/main/java/com/pi4j/extension/Plugin.java index 5794c919..6db3d0fa 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/Plugin.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/Plugin.java @@ -31,23 +31,14 @@ /** *Plugin interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface Plugin { /** - *initialize.
- * - * @param service a {@link com.pi4j.extension.PluginService} object. * @throws InitializeException if error occurs initializing the plugin */ void initialize(PluginService service) throws InitializeException; /** - *shutdown.
- * - * @param context a {@link com.pi4j.context.Context} object. * @throws ShutdownException if an error occurs shutting down the plugin */ default void shutdown(Context context) throws ShutdownException { @@ -56,8 +47,6 @@ default void shutdown(Context context) throws ShutdownException { /** *Returns true if this plugin is a mock plugin, and shouldn't generally be used
- * - * @return a boolean */ default boolean isMock() { return false; diff --git a/pi4j-core/src/main/java/com/pi4j/extension/PluginService.java b/pi4j-core/src/main/java/com/pi4j/extension/PluginService.java index fa31ce37..32e6502a 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/PluginService.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/PluginService.java @@ -30,22 +30,8 @@ /** *PluginService interface.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public interface PluginService { - /** - *context.
- * - * @return a {@link com.pi4j.context.Context} object. - */ Context context(); - /** - *register.
- * - * @param provider a {@link com.pi4j.provider.Provider} object. - * @return a {@link com.pi4j.extension.PluginService} object. - */ PluginService register(Provider ... provider); } diff --git a/pi4j-core/src/main/java/com/pi4j/extension/exception/ExtensionException.java b/pi4j-core/src/main/java/com/pi4j/extension/exception/ExtensionException.java index 3ca2fdd5..1693ffa3 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/exception/ExtensionException.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/exception/ExtensionException.java @@ -34,9 +34,6 @@ * * * @see http://www.pi4j.com/ - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id */ public class ExtensionException extends Pi4JException { @@ -49,21 +46,10 @@ public ExtensionException(String message){ super(message); } - /** - *Constructor for ExtensionException.
- * - * @param cause a {@link java.lang.Throwable} object. - */ public ExtensionException(Throwable cause){ super(cause); } - /** - *Constructor for ExtensionException.
- * - * @param message a {@link java.lang.String} object. - * @param cause a {@link java.lang.Throwable} object. - */ public ExtensionException(String message, Throwable cause){ super(message,cause); } diff --git a/pi4j-core/src/main/java/com/pi4j/extension/impl/DefaultPluginService.java b/pi4j-core/src/main/java/com/pi4j/extension/impl/DefaultPluginService.java index 6fd783c4..652e80b4 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/impl/DefaultPluginService.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/impl/DefaultPluginService.java @@ -29,24 +29,11 @@ import com.pi4j.extension.PluginService; import com.pi4j.provider.Provider; -/** - *DefaultPluginService class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class DefaultPluginService implements PluginService { private Context context = null; private PluginStore store = null; - /** - *newInstance.
- * - * @param context a {@link com.pi4j.context.Context} object. - * @param store a {@link com.pi4j.extension.impl.PluginStore} object. - * @return a {@link com.pi4j.extension.PluginService} object. - */ public static PluginService newInstance(Context context, PluginStore store){ return new DefaultPluginService(context, store); } @@ -58,13 +45,11 @@ private DefaultPluginService(Context context, PluginStore store) { this.store = store; } - /** {@inheritDoc} */ @Override public Context context() { return this.context; } - /** {@inheritDoc} */ @Override public PluginService register(Provider... provider) { if(provider != null) { diff --git a/pi4j-core/src/main/java/com/pi4j/extension/impl/PluginStore.java b/pi4j-core/src/main/java/com/pi4j/extension/impl/PluginStore.java index 50e7cec6..38a472db 100644 --- a/pi4j-core/src/main/java/com/pi4j/extension/impl/PluginStore.java +++ b/pi4j-core/src/main/java/com/pi4j/extension/impl/PluginStore.java @@ -31,12 +31,6 @@ import java.util.HashSet; import java.util.Set; -/** - *PluginStore class.
- * - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id - */ public class PluginStore { public Setcreate.
- * - * @param config a {@link com.pi4j.io.gpio.digital.DigitalOutputConfig} object. - * @return a {@link com.pi4j.io.gpio.digital.DigitalOutput} object. - */ default DigitalOutput create(DigitalOutputConfig config) { return create(config, DigitalOutput.class); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.gpio.digital.DigitalInputConfig} object. - * @return a {@link com.pi4j.io.gpio.digital.DigitalInput} object. - */ default DigitalInput create(DigitalInputConfig config) { return create(config, DigitalInput.class); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.pwm.PwmConfig} object. - * @return a {@link com.pi4j.io.pwm.Pwm} object. - */ default Pwm create(PwmConfig config) { return create(config, Pwm.class); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.i2c.I2CConfig} object. - * @return a {@link com.pi4j.io.i2c.I2C} object. - */ default I2C create(I2CConfig config) { return create(config, I2C.class); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.spi.SpiConfig} object. - * @return a {@link com.pi4j.io.spi.Spi} object. - */ default Spi create(SpiConfig config) { return create(config, Spi.class); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.gpio.digital.DigitalOutputConfigBuilder} object. - * @return a {@link com.pi4j.io.gpio.digital.DigitalOutput} object. - */ default DigitalOutput create(DigitalOutputConfigBuilder config) { return create(config.build()); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.gpio.digital.DigitalInputConfigBuilder} object. - * @return a {@link com.pi4j.io.gpio.digital.DigitalInput} object. - */ default DigitalInput create(DigitalInputConfigBuilder config) { return create(config.build()); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.pwm.PwmConfigBuilder} object. - * @return a {@link com.pi4j.io.pwm.Pwm} object. - */ default Pwm create(PwmConfigBuilder config) { return create(config.build()); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.i2c.I2CConfigBuilder} object. - * @return a {@link com.pi4j.io.i2c.I2C} object. - */ default I2C create(I2CConfigBuilder config) { return create(config.build()); } - /** - *create.
- * - * @param config a {@link com.pi4j.io.spi.SpiConfigBuilder} object. - * @return a {@link com.pi4j.io.spi.Spi} object. - */ default Spi create(SpiConfigBuilder config) { return create(config.build()); } diff --git a/pi4j-core/src/main/java/com/pi4j/internal/ProviderProvider.java b/pi4j-core/src/main/java/com/pi4j/internal/ProviderProvider.java index e5011841..5c9e76ed 100644 --- a/pi4j-core/src/main/java/com/pi4j/internal/ProviderProvider.java +++ b/pi4j-core/src/main/java/com/pi4j/internal/ProviderProvider.java @@ -39,10 +39,6 @@ public interface ProviderProvider { /** - *din.
- * - * @paramdout.
- * - * @paramdigitalInput.
- * - * @paramdigitalOutput.
- * - * @parampwm.
- * - * @paramspi.
- * - * @parami2c.
- * - * @paramdigitalInput.
- * - * @paramdigitalOutput.
- * - * @parampwm.
- * - * @paramspi.
- * - * @parami2c.
- * - * @paramprovider.
- * - * @param providerId a {@link java.lang.String} object. - * @paramprovider.
- * - * @param providerId a {@link java.lang.String} object. - * @param providerClass a T object. * @paramprovider.
- * - * @param providerClass a {@link java.lang.Class} object. - * @paramprovider.
- * - * @param ioType a {@link com.pi4j.io.IOType} object. - * @paramhasProvider.
- * - * @param providerId a {@link java.lang.String} object. - * @return a boolean. - */ boolean hasProvider(String providerId); - /** - *hasProvider.
- * - * @param providerClass a {@link java.lang.Class} object. - * @paramhasProvider.
- * - * @param ioType a {@link com.pi4j.io.IOType} object. - * @paramprovider.
- * - * @param providerId a {@link java.lang.String} object. - * @paramprovider.
- * - * @param providerId a {@link java.lang.String} object. * @param providerClass - * @paramprovider.
- * - * @param providerClass a {@link java.lang.Class} object. - * @paramprovider.
- * - * @param ioType a {@link com.pi4j.io.IOType} object. - * @paramIO interface.
* - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id * @paramtype.
- * - * @return a {@link com.pi4j.io.IOType} object. - */ default IOType type() { return IOType.getByIOClass(this.getClass()); } // TODO :: RECONCILE IDENTITY PROPERTIES BETWEEN IO INSTANCE AND UNDERLYING CONFIG; PROBABLY NEED TO REMOVE THESE SETTERS - /** - *name.
- * - * @param name a {@link java.lang.String} object. - * @return a IO_TYPE object. - */ IO_TYPE name(String name); - /** - *description.
- * - * @param description a {@link java.lang.String} object. - * @return a IO_TYPE object. - */ IO_TYPE description(String description); - /** - *provider.
- * - * @return a PROVIDER_TYPE object. - */ PROVIDER_TYPE provider(); } diff --git a/pi4j-core/src/main/java/com/pi4j/io/IOBase.java b/pi4j-core/src/main/java/com/pi4j/io/IOBase.java index d5bec9ee..ff5b4a08 100644 --- a/pi4j-core/src/main/java/com/pi4j/io/IOBase.java +++ b/pi4j-core/src/main/java/com/pi4j/io/IOBase.java @@ -37,8 +37,6 @@ /** *Abstract IOBase class.
* - * @author Robert Savage (http://www.savagehomeautomation.com) - * @version $Id: $Id * @paramIOConfig interface.
* * @param