From d9cf1b19f343f3d0a405db6e19ba1619de56ede5 Mon Sep 17 00:00:00 2001 From: Denny Date: Sat, 25 Feb 2017 16:03:35 -0500 Subject: [PATCH] Removes assert() usage throughout project and replaces with Validate from apache commons. --- src/alias/id/WildcardID.java | 4 +++- .../broadcast/shoutcast/v2/ShoutcastV2Configuration.java | 3 ++- .../shoutcast/v2/ultravox/NegotiateMaxPayloadSize.java | 6 ++++-- .../broadcast/shoutcast/v2/ultravox/UltravoxMessage.java | 3 ++- src/bits/BinaryMessage.java | 5 +++-- src/bits/MultiSyncPatternMatcher.java | 4 +++- src/channel/metadata/ChannelMetadataPanel.java | 3 ++- src/dsp/filter/FloatFIRFilter.java | 3 ++- src/dsp/filter/FloatHalfBandFilter.java | 3 ++- src/dsp/filter/FloatHalfBandNoDecimateFilter.java | 3 ++- src/dsp/filter/cic/ComplexPrimeCICDecimate.java | 3 ++- src/dsp/filter/cic/RealPrimeCICDecimate.java | 3 ++- src/dsp/filter/halfband/real/HalfBandFilter.java | 4 +++- src/dsp/filter/interpolator/RealInterpolator.java | 3 ++- .../filter/polyphase/PolyphaseFIRInterpolatingFilter.java | 3 ++- src/dsp/gain/DirectGainControl.java | 3 ++- src/record/wave/MonoWaveReader.java | 3 ++- src/record/wave/WaveWriter.java | 6 ++++-- src/sample/adapter/ChannelShortAdapter.java | 3 ++- src/sample/complex/ComplexToComplexBufferAssembler.java | 3 ++- src/spectrum/SpectrumPanel.java | 5 +++-- src/util/XTEA.java | 6 ++++-- 22 files changed, 55 insertions(+), 27 deletions(-) diff --git a/src/alias/id/WildcardID.java b/src/alias/id/WildcardID.java index d4d00c3f..c5f47086 100644 --- a/src/alias/id/WildcardID.java +++ b/src/alias/id/WildcardID.java @@ -18,6 +18,8 @@ ******************************************************************************/ package alias.id; +import org.apache.commons.lang3.Validate; + import java.util.regex.Pattern; public class WildcardID implements Comparable @@ -45,7 +47,7 @@ public class WildcardID implements Comparable */ public WildcardID(String value) { - assert(value != null && value.contains(WILDCARD) && value.length() < 10); + Validate.isTrue(value != null && value.contains(WILDCARD) && value.length() < 10); mValue = value; diff --git a/src/audio/broadcast/shoutcast/v2/ShoutcastV2Configuration.java b/src/audio/broadcast/shoutcast/v2/ShoutcastV2Configuration.java index c7fafe6a..b3ba1212 100644 --- a/src/audio/broadcast/shoutcast/v2/ShoutcastV2Configuration.java +++ b/src/audio/broadcast/shoutcast/v2/ShoutcastV2Configuration.java @@ -21,6 +21,7 @@ package audio.broadcast.shoutcast.v2; import audio.broadcast.BroadcastConfiguration; import audio.broadcast.BroadcastFormat; import audio.broadcast.BroadcastServerType; +import org.apache.commons.lang3.Validate; import javax.xml.bind.annotation.XmlAttribute; @@ -90,7 +91,7 @@ public class ShoutcastV2Configuration extends BroadcastConfiguration */ public void setStreamID(int streamID) { - assert(1 <= streamID && streamID <= Integer.MAX_VALUE); + Validate.isTrue(1 <= streamID && streamID <= Integer.MAX_VALUE); mStreamID = streamID; } diff --git a/src/audio/broadcast/shoutcast/v2/ultravox/NegotiateMaxPayloadSize.java b/src/audio/broadcast/shoutcast/v2/ultravox/NegotiateMaxPayloadSize.java index 11321319..1c7cf728 100644 --- a/src/audio/broadcast/shoutcast/v2/ultravox/NegotiateMaxPayloadSize.java +++ b/src/audio/broadcast/shoutcast/v2/ultravox/NegotiateMaxPayloadSize.java @@ -18,6 +18,8 @@ ******************************************************************************/ package audio.broadcast.shoutcast.v2.ultravox; +import org.apache.commons.lang3.Validate; + public class NegotiateMaxPayloadSize extends UltravoxMessage { /** @@ -47,8 +49,8 @@ public class NegotiateMaxPayloadSize extends UltravoxMessage */ public void setMaximumPayloadSize(int desiredMaximum, int minimum) { - assert(desiredMaximum <= 16377); - assert(minimum <= 16377); + Validate.isTrue(desiredMaximum <= 16377); + Validate.isTrue(minimum <= 16377); StringBuilder sb = new StringBuilder(); sb.append(desiredMaximum).append(":").append(minimum); diff --git a/src/audio/broadcast/shoutcast/v2/ultravox/UltravoxMessage.java b/src/audio/broadcast/shoutcast/v2/ultravox/UltravoxMessage.java index eb099b20..99180df8 100644 --- a/src/audio/broadcast/shoutcast/v2/ultravox/UltravoxMessage.java +++ b/src/audio/broadcast/shoutcast/v2/ultravox/UltravoxMessage.java @@ -19,6 +19,7 @@ package audio.broadcast.shoutcast.v2.ultravox; import bits.BinaryMessage; +import org.apache.commons.lang3.Validate; import java.util.Arrays; @@ -154,7 +155,7 @@ public abstract class UltravoxMessage */ public void setSendQueuePriority(int priority) { - assert(0 <= priority && priority <= 7); + Validate.isTrue(0 <= priority && priority <= 7); mMessage.setInt(priority, SEND_QUEUE_PRIORITY); } diff --git a/src/bits/BinaryMessage.java b/src/bits/BinaryMessage.java index 56e21a12..31516602 100644 --- a/src/bits/BinaryMessage.java +++ b/src/bits/BinaryMessage.java @@ -22,6 +22,7 @@ import java.util.BitSet; import java.util.logging.LogManager; import edac.CRC; +import org.apache.commons.lang3.Validate; public class BinaryMessage extends BitSet { @@ -456,7 +457,7 @@ public class BinaryMessage extends BitSet */ public byte getByte(int index) { - assert((index + 7) <= size()); + Validate.isTrue((index + 7) <= size()); int value = 0; @@ -481,7 +482,7 @@ public class BinaryMessage extends BitSet */ public void setByte(int index, byte value) { - assert((index + 8) <= size()); + Validate.isTrue((index + 8) <= size()); int mask = 0x80; diff --git a/src/bits/MultiSyncPatternMatcher.java b/src/bits/MultiSyncPatternMatcher.java index 41f967ae..6de0d5ed 100644 --- a/src/bits/MultiSyncPatternMatcher.java +++ b/src/bits/MultiSyncPatternMatcher.java @@ -17,6 +17,8 @@ ******************************************************************************/ package bits; +import org.apache.commons.lang3.Validate; + import java.util.ArrayList; import java.util.List; @@ -39,7 +41,7 @@ public class MultiSyncPatternMatcher public MultiSyncPatternMatcher( int syncSize ) { - assert( syncSize < 64 ); + Validate.isTrue(syncSize < 64); //Setup a bit mask of all ones the length of the sync pattern mMask = (long)( ( Math.pow( 2, syncSize ) ) - 1 ); diff --git a/src/channel/metadata/ChannelMetadataPanel.java b/src/channel/metadata/ChannelMetadataPanel.java index 5fa80231..bd3fcbb1 100644 --- a/src/channel/metadata/ChannelMetadataPanel.java +++ b/src/channel/metadata/ChannelMetadataPanel.java @@ -26,6 +26,7 @@ import controller.channel.ChannelUtils; import icon.IconManager; import module.ProcessingChain; import net.miginfocom.swing.MigLayout; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import properties.SystemProperties; @@ -140,7 +141,7 @@ public class ChannelMetadataPanel extends JPanel implements ListSelectionListene public AliasedValueCellRenderer(Attribute attribute) { - assert(attribute != null); + Validate.isTrue(attribute != null); mAttribute = attribute; setHorizontalAlignment(JLabel.CENTER); } diff --git a/src/dsp/filter/FloatFIRFilter.java b/src/dsp/filter/FloatFIRFilter.java index 8355fbf0..16c0a39c 100644 --- a/src/dsp/filter/FloatFIRFilter.java +++ b/src/dsp/filter/FloatFIRFilter.java @@ -19,6 +19,7 @@ package dsp.filter; import java.util.ArrayList; +import org.apache.commons.lang3.Validate; import sample.real.RealSampleListener; public class FloatFIRFilter implements RealSampleListener @@ -139,7 +140,7 @@ public class FloatFIRFilter implements RealSampleListener private void generateIndexMap( int size ) { //Ensure we have an odd size - assert( size % 2 == 1 ); + Validate.isTrue(size % 2 == 1); mIndexMap = new int[ size ][ size ]; diff --git a/src/dsp/filter/FloatHalfBandFilter.java b/src/dsp/filter/FloatHalfBandFilter.java index 56fae571..1d65deec 100644 --- a/src/dsp/filter/FloatHalfBandFilter.java +++ b/src/dsp/filter/FloatHalfBandFilter.java @@ -19,6 +19,7 @@ package dsp.filter; import java.util.ArrayList; +import org.apache.commons.lang3.Validate; import sample.real.RealSampleListener; public class FloatHalfBandFilter implements RealSampleListener @@ -149,7 +150,7 @@ public class FloatHalfBandFilter implements RealSampleListener private void generateIndexMap( int size ) { //Ensure we have an odd size - assert( size % 2 == 1 ); + Validate.isTrue(size % 2 == 1); int mapWidth = ( ( size + 1 ) / 2 ) + 1; diff --git a/src/dsp/filter/FloatHalfBandNoDecimateFilter.java b/src/dsp/filter/FloatHalfBandNoDecimateFilter.java index 6f38db1f..f2561bce 100644 --- a/src/dsp/filter/FloatHalfBandNoDecimateFilter.java +++ b/src/dsp/filter/FloatHalfBandNoDecimateFilter.java @@ -19,6 +19,7 @@ package dsp.filter; import java.util.ArrayList; +import org.apache.commons.lang3.Validate; import sample.real.RealSampleListener; public class FloatHalfBandNoDecimateFilter implements RealSampleListener @@ -139,7 +140,7 @@ public class FloatHalfBandNoDecimateFilter implements RealSampleListener private void generateIndexMap( int size ) { //Ensure we have an odd size - assert( size % 2 == 1 ); + Validate.isTrue(size % 2 == 1); int mapWidth = ( ( size + 1 ) / 2 ) + 1; diff --git a/src/dsp/filter/cic/ComplexPrimeCICDecimate.java b/src/dsp/filter/cic/ComplexPrimeCICDecimate.java index 80b0c206..72a869d0 100644 --- a/src/dsp/filter/cic/ComplexPrimeCICDecimate.java +++ b/src/dsp/filter/cic/ComplexPrimeCICDecimate.java @@ -20,6 +20,7 @@ package dsp.filter.cic; import java.util.ArrayList; import java.util.List; +import org.apache.commons.lang3.Validate; import sample.Listener; import sample.complex.ComplexBuffer; import sample.complex.ComplexSampleListener; @@ -67,7 +68,7 @@ public class ComplexPrimeCICDecimate implements Listener public ComplexPrimeCICDecimate( int decimation, int order, int passFrequency, int attenuation, WindowType windowType ) { - assert( decimation <= 700 ); + Validate.isTrue(decimation <= 700); List stageSizes = getPrimeFactors( decimation ); diff --git a/src/dsp/filter/cic/RealPrimeCICDecimate.java b/src/dsp/filter/cic/RealPrimeCICDecimate.java index 8e359cea..36964a05 100644 --- a/src/dsp/filter/cic/RealPrimeCICDecimate.java +++ b/src/dsp/filter/cic/RealPrimeCICDecimate.java @@ -20,6 +20,7 @@ package dsp.filter.cic; import java.util.ArrayList; import java.util.List; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -81,7 +82,7 @@ public class RealPrimeCICDecimate public RealPrimeCICDecimate( int decimation, int order, int passFrequency, int attenuation, WindowType windowType, int outputBufferSize ) { - assert( decimation <= 700 ); + Validate.isTrue(decimation <= 700); mOutputBufferSize = outputBufferSize; diff --git a/src/dsp/filter/halfband/real/HalfBandFilter.java b/src/dsp/filter/halfband/real/HalfBandFilter.java index 7b84616f..831c8b5c 100644 --- a/src/dsp/filter/halfband/real/HalfBandFilter.java +++ b/src/dsp/filter/halfband/real/HalfBandFilter.java @@ -17,6 +17,8 @@ ******************************************************************************/ package dsp.filter.halfband.real; +import org.apache.commons.lang3.Validate; + public class HalfBandFilter { private float[] mBuffer; @@ -122,7 +124,7 @@ public class HalfBandFilter private void generateIndexMap( int size ) { //Ensure we have an odd size - assert( size % 2 == 1 ); + Validate.isTrue(size % 2 == 1); int mapWidth = ( ( size + 1 ) / 2 ) + 1; diff --git a/src/dsp/filter/interpolator/RealInterpolator.java b/src/dsp/filter/interpolator/RealInterpolator.java index f840a3ed..26941ac0 100644 --- a/src/dsp/filter/interpolator/RealInterpolator.java +++ b/src/dsp/filter/interpolator/RealInterpolator.java @@ -1,5 +1,6 @@ package dsp.filter.interpolator; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -31,7 +32,7 @@ public class RealInterpolator extends Interpolator public float filter( float[] samples, int offset, float mu ) { /* Ensure we have enough samples in the array */ - assert( samples.length >= offset + 7 ); + Validate.isTrue(samples.length >= offset + 7); /* Identify the filter bank that corresponds to mu */ int index = (int)( NSTEPS * mu ); diff --git a/src/dsp/filter/polyphase/PolyphaseFIRInterpolatingFilter.java b/src/dsp/filter/polyphase/PolyphaseFIRInterpolatingFilter.java index 65b41b46..992a14a6 100644 --- a/src/dsp/filter/polyphase/PolyphaseFIRInterpolatingFilter.java +++ b/src/dsp/filter/polyphase/PolyphaseFIRInterpolatingFilter.java @@ -18,6 +18,7 @@ ******************************************************************************/ package dsp.filter.polyphase; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -53,7 +54,7 @@ public class PolyphaseFIRInterpolatingFilter public PolyphaseFIRInterpolatingFilter( double[] coefficients, int interpolation ) { /* Ensure coefficients are an integral multiple of the interpolation factor */ - assert( coefficients.length % interpolation == 0 ); + Validate.isTrue(coefficients.length % interpolation == 0); mTaps = coefficients; diff --git a/src/dsp/gain/DirectGainControl.java b/src/dsp/gain/DirectGainControl.java index 2f9ab934..01c167c8 100644 --- a/src/dsp/gain/DirectGainControl.java +++ b/src/dsp/gain/DirectGainControl.java @@ -17,6 +17,7 @@ ******************************************************************************/ package dsp.gain; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -49,7 +50,7 @@ public class DirectGainControl implements GainController, RealSampleListener */ public DirectGainControl( float gain, float minimum, float maximum, float increment ) { - assert( minimum > 0 ); + Validate.isTrue(minimum > 0); mDefaultGain = gain; mGain = gain; diff --git a/src/record/wave/MonoWaveReader.java b/src/record/wave/MonoWaveReader.java index 25b076e9..a03cf94f 100644 --- a/src/record/wave/MonoWaveReader.java +++ b/src/record/wave/MonoWaveReader.java @@ -18,6 +18,7 @@ ******************************************************************************/ package record.wave; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import sample.ConversionUtils; @@ -58,7 +59,7 @@ public class MonoWaveReader implements AutoCloseable */ public MonoWaveReader(Path path, boolean realTime) throws IOException { - assert( path != null ); + Validate.isTrue(path != null); mPath = path; mRealTime = realTime; diff --git a/src/record/wave/WaveWriter.java b/src/record/wave/WaveWriter.java index c5e37b24..a7733e69 100644 --- a/src/record/wave/WaveWriter.java +++ b/src/record/wave/WaveWriter.java @@ -17,6 +17,8 @@ ******************************************************************************/ package record.wave; +import org.apache.commons.lang3.Validate; + import java.io.IOException; import java.nio.ByteBuffer; import java.nio.channels.FileChannel; @@ -59,8 +61,8 @@ public class WaveWriter implements AutoCloseable public WaveWriter( AudioFormat format, Path file, long maxSize ) throws IOException { - assert( format != null ); - assert( file != null ); + Validate.isTrue(format != null); + Validate.isTrue( file != null ); mAudioFormat = format; mFile = file; diff --git a/src/sample/adapter/ChannelShortAdapter.java b/src/sample/adapter/ChannelShortAdapter.java index 6245a250..e974f82a 100644 --- a/src/sample/adapter/ChannelShortAdapter.java +++ b/src/sample/adapter/ChannelShortAdapter.java @@ -20,6 +20,7 @@ package sample.adapter; import java.nio.ByteBuffer; import java.nio.ByteOrder; +import org.apache.commons.lang3.Validate; import source.mixer.MixerChannel; /** @@ -34,7 +35,7 @@ public class ChannelShortAdapter implements ISampleAdapter public ChannelShortAdapter( MixerChannel channel ) { /* Only use with LEFT/RIGHT channels */ - assert( channel != MixerChannel.MONO ); + Validate.isTrue(channel != MixerChannel.MONO); mMixerChannel = channel; } diff --git a/src/sample/complex/ComplexToComplexBufferAssembler.java b/src/sample/complex/ComplexToComplexBufferAssembler.java index 66dd239a..586d21c3 100644 --- a/src/sample/complex/ComplexToComplexBufferAssembler.java +++ b/src/sample/complex/ComplexToComplexBufferAssembler.java @@ -17,6 +17,7 @@ ******************************************************************************/ package sample.complex; +import org.apache.commons.lang3.Validate; import sample.Listener; /** @@ -32,7 +33,7 @@ public class ComplexToComplexBufferAssembler implements ComplexSampleListener public ComplexToComplexBufferAssembler( int bufferSize ) { - assert( bufferSize % 2 == 0 ); + Validate.isTrue(bufferSize % 2 == 0); mBufferSize = bufferSize; mBuffer = new float[ mBufferSize ]; diff --git a/src/spectrum/SpectrumPanel.java b/src/spectrum/SpectrumPanel.java index d2295cbe..d16b35a8 100644 --- a/src/spectrum/SpectrumPanel.java +++ b/src/spectrum/SpectrumPanel.java @@ -30,6 +30,7 @@ import java.util.Arrays; import javax.swing.JPanel; +import org.apache.commons.lang3.Validate; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -282,7 +283,7 @@ public class SpectrumPanel extends JPanel */ public void setZoom( int zoom ) { - assert( 0 <= zoom && zoom <= 5 ); + Validate.isTrue( 0 <= zoom && zoom <= 5 ); mZoom = zoom; } @@ -305,7 +306,7 @@ public class SpectrumPanel extends JPanel */ public void setSampleSize( double sampleSize ) { - assert( 2.0 <= sampleSize && sampleSize <= 32.0 ); + Validate.isTrue(2.0 <= sampleSize && sampleSize <= 32.0); mDBScale = (float)( 20.0 * Math.log10( Math.pow( 2.0, sampleSize - 1 ) ) ); } diff --git a/src/util/XTEA.java b/src/util/XTEA.java index 575c92c8..9ab8c48c 100644 --- a/src/util/XTEA.java +++ b/src/util/XTEA.java @@ -18,6 +18,8 @@ ******************************************************************************/ package util; +import org.apache.commons.lang3.Validate; + import java.util.Arrays; public class XTEA @@ -58,7 +60,7 @@ public class XTEA */ public void setKey(byte[] key) { - assert(key.length == 16); + Validate.isTrue(key.length == 16); int keyInts[] = new int[8]; @@ -94,7 +96,7 @@ public class XTEA */ public byte[] encrypt(byte[] plainText) { - assert(plainText.length == 8); + Validate.isTrue(plainText.length == 8); //Convert the 8 bytes of plaintext to 2 integers int result0 = (plainText[3] << 0) & MASK0 | (plainText[2] << 8) & MASK1 |