Skip to content

Commit

Permalink
clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
@ChristianHoesel
ChristianHoesel committed Sep 13, 2024
1 parent 1f127c1 commit 6d43649
Show file tree
Hide file tree
Showing 111 changed files with 1,334 additions and 1,756 deletions.
4 changes: 2 additions & 2 deletions src/main/java/com/bitctrl/Constants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ public final class Constants {
/**
* Ein leerer String.
* <p>
* <em>Hinweis</em>: Der Test mit {@code equals()} auf den Leerstring ist
* sehr ineffektiv, deswegen sollte bis Java 6 besser geprüft werden ob
* <em>Hinweis</em>: Der Test mit {@code equals()} auf den Leerstring ist sehr
* ineffektiv, deswegen sollte bis Java 6 besser geprüft werden ob
* {@link String#length()} gleich 0 ist. Ab Java 6 kann für den Test auf den
* Leerstring {@link String#isEmpty()} verwendet werden.
*/
Expand Down
45 changes: 16 additions & 29 deletions src/main/java/com/bitctrl/ReleaseInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ public class ReleaseInfo {
/**
* Erzeugt eine Versionsnummer.
*
* @param major
* das Major-Release.
* @param major das Major-Release.
*/
public ReleaseInfo(final int major) {
this.major = major;
Expand All @@ -60,10 +59,8 @@ public ReleaseInfo(final int major) {
/**
* Erzeugt eine Versionsnummer.
*
* @param major
* das Major-Release.
* @param minor
* das Minor-Release.
* @param major das Major-Release.
* @param minor das Minor-Release.
*/
public ReleaseInfo(final int major, final int minor) {
this.major = major;
Expand All @@ -75,12 +72,9 @@ public ReleaseInfo(final int major, final int minor) {
/**
* Erzeugt eine Versionsnummer.
*
* @param major
* das Major-Release.
* @param minor
* das Minor-Release.
* @param patchLevel
* der Patch-Level.
* @param major das Major-Release.
* @param minor das Minor-Release.
* @param patchLevel der Patch-Level.
*/
public ReleaseInfo(final int major, final int minor, final int patchLevel) {
this.major = major;
Expand All @@ -92,17 +86,12 @@ public ReleaseInfo(final int major, final int minor, final int patchLevel) {
/**
* Erzeugt eine Versionsnummer.
*
* @param major
* das Major-Release.
* @param minor
* das Minor-Release.
* @param patchLevel
* der Patch-Level.
* @param buildNumber
* die Build-Number.
* @param major das Major-Release.
* @param minor das Minor-Release.
* @param patchLevel der Patch-Level.
* @param buildNumber die Build-Number.
*/
public ReleaseInfo(final int major, final int minor, final int patchLevel,
final int buildNumber) {
public ReleaseInfo(final int major, final int minor, final int patchLevel, final int buildNumber) {
this.major = major;
this.minor = minor;
this.patchLevel = patchLevel;
Expand All @@ -112,8 +101,7 @@ public ReleaseInfo(final int major, final int minor, final int patchLevel,
/**
* Erzeugt eine Versionsnummer.
*
* @param release
* ein String, der die Versionsnummer enthält.
* @param release ein String, der die Versionsnummer enthält.
*/
public ReleaseInfo(final String release) {
if (Pattern.matches(PATTERN, release)) {
Expand Down Expand Up @@ -156,8 +144,7 @@ public ReleaseInfo(final String release) {
}
buildNumber = Integer.valueOf(release.substring(start));
} else {
throw new IllegalArgumentException(
"Release muss dem Muster 1[.4[.2[-15]]] entsprechen.");
throw new IllegalArgumentException("Release muss dem Muster 1[.4[.2[-15]]] entsprechen.");
}
}

Expand Down Expand Up @@ -198,9 +185,9 @@ public Integer getPatchLevel() {
}

/**
* Gibt das Release für den Menschen lesbar zurück. Teile die nicht
* angegeben sind, werden nicht ausgegeben. Fehlt z.&nbsp;B. die Build
* Number wird diese auch nicht berücksichtigt.
* Gibt das Release für den Menschen lesbar zurück. Teile die nicht angegeben
* sind, werden nicht ausgegeben. Fehlt z.&nbsp;B. die Build Number wird diese
* auch nicht berücksichtigt.
*
* @return ein Text nach dem Muster 1[.4[.2[-15]]].
*/
Expand Down
24 changes: 9 additions & 15 deletions src/main/java/com/bitctrl/VersionInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ public class VersionInfo {
/**
* Liest die Beschreibung aus dem Manifest-File.
*
* @param manifest
* ein Manifestfile.
* @param manifest ein Manifestfile.
* @see Attributes.Name#IMPLEMENTATION_TITLE
* @see Attributes.Name#IMPLEMENTATION_VERSION
* @see Attributes.Name#IMPLEMENTATION_VENDOR
Expand All @@ -66,26 +65,21 @@ public VersionInfo(final Manifest manifest) {
/**
* Erzeugt eine Beschreibung.
*
* @param title
* der Name der Applikation oder der Bibliothek.
* @param version
* die Versionsnummer.
* @param vendor
* das Unternehmen.
* @param vendorUrl
* die Internetseite des Unternehmens.
* @param title der Name der Applikation oder der Bibliothek.
* @param version die Versionsnummer.
* @param vendor das Unternehmen.
* @param vendorUrl die Internetseite des Unternehmens.
*/
public VersionInfo(final String title, final String version,
final String vendor, final String vendorUrl) {
public VersionInfo(final String title, final String version, final String vendor, final String vendorUrl) {
this.title = title;
this.version = version;
this.vendor = vendor;
this.vendorUrl = vendorUrl;
}

/**
* Gibt die Versionsnummer als {@code ReleaseInfo} zurück. Dies ist nur
* möglich, wenn die Versionsnummer einer Releasenummer entspricht.
* Gibt die Versionsnummer als {@code ReleaseInfo} zurück. Dies ist nur möglich,
* wenn die Versionsnummer einer Releasenummer entspricht.
*
* @return das Release.
*/
Expand All @@ -110,7 +104,7 @@ public String getTitle() {
public URL getURL() {
try {
return new URL(getVendorUrl());
} catch (MalformedURLException ex) {
} catch (final MalformedURLException ex) {
throw new IllegalStateException(ex);
}
}
Expand Down
84 changes: 41 additions & 43 deletions src/main/java/com/bitctrl/beans/AbstractBeanInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ public abstract class AbstractBeanInfo extends SimpleBeanInfo {
* Die Methode legt die zu beschreibende Java Bean fest und setzt deren
* übersetzten Namen und Kurzbeschreibung. Da sich die Bean zur Laufzeit
* i.&nbsp;d.&nbsp;R. nicht ändert wird das Ergebnis der Funktion intern
* statisch gecacht, so dass der Aufruf ab dem zweiten Mal schneller
* vonstatten geht.
* statisch gecacht, so dass der Aufruf ab dem zweiten Mal schneller vonstatten
* geht.
*
* {@inheritDoc}
*
Expand All @@ -76,7 +76,8 @@ public BeanDescriptor getBeanDescriptor() {
/**
* Die Methode registriert die vorhandenen Properties und setzt deren übersetzte
* Namen und Kurzbeschreibungen. In Umgebungen mit Mehrsprachigkeit können sich
* die Properties zur Laufzeit ändern (z.B. {@link #getDisplayName(PropertyInfo)}.
* die Properties zur Laufzeit ändern (z.B.
* {@link #getDisplayName(PropertyInfo)}.
*
* {@inheritDoc}
*
Expand All @@ -100,12 +101,12 @@ public PropertyDescriptor[] getPropertyDescriptors() {
for (int i = 0; i < propertyDescriptors.length; ++i) {
final PropertyDescriptor prop;

Class<?> beanClass = getBeanClass();
final Class<?> beanClass = getBeanClass();
String propName = propInfo[i].name();
propName = propName.substring(0, 1).toUpperCase() + propName.substring(1);

String readMethodName = getReadMethodName(beanClass, propName);
String writeMethodName = getWriteMethodName(beanClass, propName);
final String readMethodName = getReadMethodName(beanClass, propName);
final String writeMethodName = getWriteMethodName(beanClass, propName);

prop = new PropertyDescriptor(propInfo[i].name(), getBeanClass(), readMethodName, writeMethodName);
prop.setDisplayName(getDisplayName(propInfo[i]));
Expand All @@ -130,33 +131,32 @@ public PropertyDescriptor[] getPropertyDescriptors() {
}

private String getReadMethodName(Class<?> beanClass, String propName) {

try {
return beanClass.getMethod("get" + propName).getName();
} catch (NoSuchMethodException ignored) {
} catch (final NoSuchMethodException ignored) {
try {
return beanClass.getMethod("is" + propName).getName();
} catch (NoSuchMethodException ex) {
} catch (final NoSuchMethodException ex) {
return null;
}
}
}

private String getWriteMethodName(Class<?> beanClass, String propName) {
String name = "set" + propName;
Method[] methods = beanClass.getMethods();
for ( Method method : methods) {
if( name.equals(method.getName())) {

final String name = "set" + propName;

final Method[] methods = beanClass.getMethods();
for (final Method method : methods) {
if (name.equals(method.getName())) {
return name;
}
}

return null;
}


/**
* Gibt die Liste der Properties zurück der Java Bean zurück.
*
Expand All @@ -165,24 +165,24 @@ private String getWriteMethodName(Class<?> beanClass, String propName) {
protected abstract PropertyInfo[] getProperties();

/**
* Gibt die Liste der Properties zurück, die standardmäßig ausgeblendet
* werden sollen. Abgeleite Klassen können die Methode überschreiben. Die
* Gibt die Liste der Properties zurück, die standardmäßig ausgeblendet werden
* sollen. Abgeleite Klassen können die Methode überschreiben. Die
* Standardimplementierung gibt eine leere Liste zurück.
* <p>
* <em>Hinweis:</em> Die versteckten Properties müssen auch in der Liste
* aller Properties enthalten sein.
* <em>Hinweis:</em> Die versteckten Properties müssen auch in der Liste aller
* Properties enthalten sein.
*
* @return die Liste der versteckten Properties oder ein leeres Feld,
* niemals {@code null}.
* @return die Liste der versteckten Properties oder ein leeres Feld, niemals
* {@code null}.
* @see #getProperties()
*/
protected PropertyInfo[] getHiddenProperties() {
return new PropertyInfo[0];
}

/**
* Gibt die Liste der Properties zurück, die als wichtig hervorgehoben
* werden sollen. Abgeleite Klassen können die Methode überschreiben. Die
* Gibt die Liste der Properties zurück, die als wichtig hervorgehoben werden
* sollen. Abgeleite Klassen können die Methode überschreiben. Die
* Standardimplementierung gibt eine leere Liste zurück.
* <p>
* <em>Hinweis:</em> Die wichtigen Properties müssen auch in der Liste aller
Expand All @@ -198,8 +198,8 @@ protected PropertyInfo[] getPreferredProperties() {

/**
* Gibt die Liste der Properties zurück, die nur fortgeschrittenen Nutzern
* angeboten werden sollen. Abgeleite Klassen können die Methode
* überschreiben. Die Standardimplementierung gibt eine leere Liste zurück.
* angeboten werden sollen. Abgeleite Klassen können die Methode überschreiben.
* Die Standardimplementierung gibt eine leere Liste zurück.
* <p>
* <em>Hinweis:</em> Die Expertenproperties müssen auch in der Liste aller
* Properties enthalten sein.
Expand All @@ -214,25 +214,23 @@ protected PropertyInfo[] getExpertProperties() {

/**
* Gibt den übersetzten Namen der Property zurück. Die Methode sollte in
* abgeleiteten Klassen überschrieben werden. Die Standardimplementierung
* gibt einfach den Propertynamen zurück.
* abgeleiteten Klassen überschrieben werden. Die Standardimplementierung gibt
* einfach den Propertynamen zurück.
*
* @param info
* eine Propertybeschreibung.
* @param info eine Propertybeschreibung.
* @return der übersetzte Propertyname.
*/
protected String getDisplayName(final PropertyInfo info) {
return info.name();
}

/**
* Gibt eine kurze Beschreibung der Property zurück. Diese kann z.&nbsp;B.
* von einem Editor als Tooltip angezeigt werden. Die Methode sollte in
* abgeleiteten Klassen überschrieben werden. Die Standardimplementierung
* gibt einfach den übersetzen Propertynamen zurück.
* Gibt eine kurze Beschreibung der Property zurück. Diese kann z.&nbsp;B. von
* einem Editor als Tooltip angezeigt werden. Die Methode sollte in abgeleiteten
* Klassen überschrieben werden. Die Standardimplementierung gibt einfach den
* übersetzen Propertynamen zurück.
*
* @param info
* eine Propertybeschreibung.
* @param info eine Propertybeschreibung.
* @return die kurze Beanbeschreibung.
* @see #getDisplayName(PropertyInfo)
*/
Expand All @@ -249,8 +247,8 @@ protected String getShortDescription(final PropertyInfo info) {

/**
* Gibt den übersetzten Namen der Java Bean zurück. Die Methode sollte in
* abgeleiteten Klassen überschrieben werden. Die Standardimplementierung
* gibt einfach den Klassennamen (ohne Package) zurück.
* abgeleiteten Klassen überschrieben werden. Die Standardimplementierung gibt
* einfach den Klassennamen (ohne Package) zurück.
*
* @return der übersetzte Beanname.
*/
Expand All @@ -259,10 +257,10 @@ protected String getDisplayName() {
}

/**
* Gibt eine kurze Beschreibung der Java Bean zurück. Diese kann z.&nbsp;B.
* von einem Editor als Tooltip angezeigt werden. Die Methode sollte in
* abgeleiteten Klassen überschrieben werden. Die Standardimplementierung
* gibt einfach den übersetzen Beannamen zurück.
* Gibt eine kurze Beschreibung der Java Bean zurück. Diese kann z.&nbsp;B. von
* einem Editor als Tooltip angezeigt werden. Die Methode sollte in abgeleiteten
* Klassen überschrieben werden. Die Standardimplementierung gibt einfach den
* übersetzen Beannamen zurück.
*
* @return die kurze Beanbeschreibung.
* @see #getDisplayName()
Expand Down
6 changes: 2 additions & 4 deletions src/main/java/com/bitctrl/beans/BeanEvent.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,8 @@ public class BeanEvent extends EventObject {
/**
* Initialisert das Event.
*
* @param source
* die Quelle des Events.
* @param beanData
* die neuen Daten der Bean.
* @param source die Quelle des Events.
* @param beanData die neuen Daten der Bean.
*/
public BeanEvent(final Object source, final Object beanData) {
super(source);
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/com/bitctrl/beans/BeanListener.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ public interface BeanListener extends EventListener {
/**
* Informiert einen Listener über die Propertyänderung an einer Bean.
*
* @param e
* das Event.
* @param e das Event.
*/
void beanChanged(BeanEvent e);

Expand Down
Loading

0 comments on commit 6d43649

Please sign in to comment.