Compare commits
17 Commits
release@1.
...
release@1.
| Author | SHA1 | Date | |
|---|---|---|---|
|
90efd93b72
|
|||
|
b002d47d82
|
|||
|
2cf6d206e8
|
|||
|
cadf80ea63
|
|||
|
33037293fc
|
|||
|
8d21502f60
|
|||
|
5f46fa13e6
|
|||
|
456d1cf30c
|
|||
|
e5c4c7afd7
|
|||
|
df948368d4
|
|||
|
9acd15ef6d
|
|||
|
2722115959
|
|||
|
aa77d8fe7d
|
|||
|
ec738e30b8
|
|||
|
c9d17696e2
|
|||
|
36233ab444
|
|||
|
bd7bcf54a5
|
@@ -31,14 +31,18 @@ jobs:
|
|||||||
restore-keys: |
|
restore-keys: |
|
||||||
${{ runner.os }}-gradle-
|
${{ runner.os }}-gradle-
|
||||||
|
|
||||||
- name: Build and publish to Gitea Maven
|
- name: Setup SSH key and rsync
|
||||||
run: ./gradlew clean publish --no-daemon -PgiteaToken=${{ secrets.CI_PUBLISH_TOKEN }}
|
run: |
|
||||||
|
mkdir -p ~/.ssh
|
||||||
|
echo "${{ secrets.JAVADOC_SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
|
||||||
|
echo "${{ secrets.CI_KNOWN_HOSTS }}" > ~/.ssh/known_hosts
|
||||||
|
chmod -R 600 ~/.ssh
|
||||||
|
rm /etc/apt/sources.list.d/microsoft-prod.list
|
||||||
|
apt-get update
|
||||||
|
apt install -y rsync
|
||||||
|
|
||||||
- name: Upload built JAR
|
- name: Build and publish to Gitea Maven and JavaDoc to the website
|
||||||
uses: actions/upload-artifact@v3
|
run: ./gradlew clean publish uploadJavadoc --no-daemon -PgiteaToken=${{ secrets.CI_PUBLISH_TOKEN }} -PjavadocUser=${{ vars.JAVADOC_USER }} -PjavadocHost=${{ vars.JAVADOC_HOST }} -PjavadocPath=${{ vars.JAVADOC_PATH }} -PjavadocKeyPath=~/.ssh/id_rsa
|
||||||
with:
|
|
||||||
name: conflux
|
|
||||||
path: build/libs/*.jar
|
|
||||||
|
|
||||||
- name: Generate release notes
|
- name: Generate release notes
|
||||||
id: notes
|
id: notes
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Bump version and tag
|
- name: Bump version and tag
|
||||||
run: |
|
run: |
|
||||||
latest=$(git tag --list 'conflux@*' | sed 's/conflux@//' | sort -V | tail -n 1)
|
latest=$(git tag --list 'release@*' | sed 's/release@//' | sort -V | tail -n 1)
|
||||||
if [[ -z "$latest" ]]; then
|
if [[ -z "$latest" ]]; then
|
||||||
latest="0.0.0"
|
latest="0.0.0"
|
||||||
fi
|
fi
|
||||||
|
|||||||
6
.project
6
.project
@@ -15,15 +15,9 @@
|
|||||||
<arguments>
|
<arguments>
|
||||||
</arguments>
|
</arguments>
|
||||||
</buildCommand>
|
</buildCommand>
|
||||||
<buildCommand>
|
|
||||||
<name>net.sourceforge.pmd.eclipse.plugin.pmdBuilder</name>
|
|
||||||
<arguments>
|
|
||||||
</arguments>
|
|
||||||
</buildCommand>
|
|
||||||
</buildSpec>
|
</buildSpec>
|
||||||
<natures>
|
<natures>
|
||||||
<nature>org.eclipse.jdt.core.javanature</nature>
|
<nature>org.eclipse.jdt.core.javanature</nature>
|
||||||
<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
|
<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
|
||||||
<nature>net.sourceforge.pmd.eclipse.plugin.pmdNature</nature>
|
|
||||||
</natures>
|
</natures>
|
||||||
</projectDescription>
|
</projectDescription>
|
||||||
|
|||||||
298
.ruleset
Normal file
298
.ruleset
Normal file
@@ -0,0 +1,298 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
name="EgothorRuleset"
|
||||||
|
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
|
||||||
|
<description>Egothor preferences rule set</description>
|
||||||
|
<exclude-pattern>.*</exclude-pattern>
|
||||||
|
<include-pattern>.*\.java</include-pattern>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AbstractClassWithoutAbstractMethod"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AccessorClassGeneration"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AccessorMethodGeneration"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ArrayIsStoredDirectly"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidMessageDigestField"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidPrintStackTrace"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidReassigningCatchVariables"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidReassigningLoopVariables"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidReassigningParameters"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidStringBufferField"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/CheckResultSet"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ConstantsInInterface"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/DefaultLabelNotLastInSwitch"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/DoubleBraceInitialization"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ExhaustiveSwitchHasDefault"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ForLoopCanBeForeach"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ForLoopVariableCount"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/GuardLogStatement"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ImplicitFunctionalInterface"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/JUnit4SuitesShouldUseSuiteAnnotation"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/JUnit5TestShouldBePackagePrivate"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/JUnitUseExpected"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/LiteralsFirstInComparisons"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/LooseCoupling"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/MethodReturnsInternalArray"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/MissingOverride"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/NonExhaustiveSwitch"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/OneDeclarationPerLine"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/PreserveStackTrace"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/PrimitiveWrapperInstantiation"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ReplaceEnumerationWithIterator"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ReplaceHashtableWithMap"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/ReplaceVectorWithList"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/SimplifiableTestAssertion"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/SystemPrintln"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnitTestAssertionsShouldIncludeMessage"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnitTestContainsTooManyAsserts"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnitTestShouldIncludeAssert"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnitTestShouldUseAfterAnnotation"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnitTestShouldUseBeforeAnnotation"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnitTestShouldUseTestAnnotation"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnnecessaryVarargsArrayCreation"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnnecessaryWarningSuppression"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnusedAssignment"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnusedFormalParameter"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnusedLocalVariable"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnusedPrivateField"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UnusedPrivateMethod"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UseCollectionIsEmpty"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UseEnumCollections"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UseStandardCharsets"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UseTryWithResources"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/UseVarargs"/>
|
||||||
|
<rule ref="category/java/bestpractices.xml/WhileLoopWithLiteralBoolean"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/AtLeastOneConstructor"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/AvoidDollarSigns"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/AvoidProtectedFieldInFinalClass"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/AvoidProtectedMethodInFinalClassNotExtending"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/AvoidUsingNativeCode"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/BooleanGetMethodName"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/CallSuperInConstructor"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ClassNamingConventions"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/CommentDefaultAccessModifier"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ConfusingTernary"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ControlStatementBraces"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/EmptyControlStatement"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/EmptyMethodInAbstractClassShouldBeAbstract"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ExtendsObject"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/FieldDeclarationsShouldBeAtStartOfClass"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/FieldNamingConventions"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/FinalParameterInAbstractMethod"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ForLoopShouldBeWhileLoop"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/FormalParameterNamingConventions"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/GenericsNaming"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/IdenticalCatchBranches"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/LambdaCanBeMethodReference"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/LinguisticNaming"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/LocalHomeNamingConvention"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/LocalInterfaceSessionNamingConvention"/>
|
||||||
|
<!-- rule ref="category/java/codestyle.xml/LocalVariableCouldBeFinal"/ -->
|
||||||
|
<rule ref="category/java/codestyle.xml/LocalVariableNamingConventions"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/LongVariable"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/MDBAndSessionBeanNamingConvention"/>
|
||||||
|
<!-- rule ref="category/java/codestyle.xml/MethodArgumentCouldBeFinal"/ -->
|
||||||
|
<rule ref="category/java/codestyle.xml/MethodNamingConventions"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/NoPackage"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/OnlyOneReturn"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/PackageCase"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/PrematureDeclaration"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/RemoteInterfaceNamingConvention"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/RemoteSessionInterfaceNamingConvention"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ShortClassName"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/ShortMethodName"/>
|
||||||
|
<!-- rule ref="category/java/codestyle.xml/ShortVariable"/ -->
|
||||||
|
<rule ref="category/java/codestyle.xml/TooManyStaticImports"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryAnnotationValueElement"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryBoxing"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryCast"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryConstructor"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryFullyQualifiedName"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryImport"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryLocalBeforeReturn"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryModifier"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessaryReturn"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UnnecessarySemicolon"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UseDiamondOperator"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UseExplicitTypes"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UselessParentheses"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UselessQualifiedThis"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UseShortArrayInitializer"/>
|
||||||
|
<rule ref="category/java/codestyle.xml/UseUnderscoresInNumericLiterals"/>
|
||||||
|
<rule ref="category/java/design.xml/AbstractClassWithoutAnyMethod"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidCatchingGenericException"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidDeeplyNestedIfStmts"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidRethrowingException"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidThrowingNewInstanceOfSameException"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidThrowingNullPointerException"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidThrowingRawExceptionTypes"/>
|
||||||
|
<rule ref="category/java/design.xml/AvoidUncheckedExceptionsInSignatures"/>
|
||||||
|
<rule ref="category/java/design.xml/ClassWithOnlyPrivateConstructorsShouldBeFinal"/>
|
||||||
|
<rule ref="category/java/design.xml/CognitiveComplexity"/>
|
||||||
|
<rule ref="category/java/design.xml/CollapsibleIfStatements"/>
|
||||||
|
<rule ref="category/java/design.xml/CouplingBetweenObjects"/>
|
||||||
|
<rule ref="category/java/design.xml/CyclomaticComplexity"/>
|
||||||
|
<rule ref="category/java/design.xml/DataClass"/>
|
||||||
|
<rule ref="category/java/design.xml/DoNotExtendJavaLangError"/>
|
||||||
|
<rule ref="category/java/design.xml/ExceptionAsFlowControl"/>
|
||||||
|
<!-- rule ref="category/java/design.xml/ExcessiveImports"/ -->
|
||||||
|
<rule ref="category/java/design.xml/ExcessiveParameterList"/>
|
||||||
|
<rule ref="category/java/design.xml/ExcessivePublicCount"/>
|
||||||
|
<rule ref="category/java/design.xml/FinalFieldCouldBeStatic"/>
|
||||||
|
<rule ref="category/java/design.xml/GodClass"/>
|
||||||
|
<rule ref="category/java/design.xml/ImmutableField"/>
|
||||||
|
<rule ref="category/java/design.xml/InvalidJavaBean"/>
|
||||||
|
<!-- rule ref="category/java/design.xml/LawOfDemeter"/ -->
|
||||||
|
<rule ref="category/java/design.xml/LogicInversion"/>
|
||||||
|
<!-- rule ref="category/java/design.xml/LoosePackageCoupling"/ -->
|
||||||
|
<rule ref="category/java/design.xml/MutableStaticState"/>
|
||||||
|
<rule ref="category/java/design.xml/NcssCount"/>
|
||||||
|
<rule ref="category/java/design.xml/NPathComplexity"/>
|
||||||
|
<rule ref="category/java/design.xml/SignatureDeclareThrowsException"/>
|
||||||
|
<rule ref="category/java/design.xml/SimplifiedTernary"/>
|
||||||
|
<rule ref="category/java/design.xml/SimplifyBooleanExpressions"/>
|
||||||
|
<rule ref="category/java/design.xml/SimplifyBooleanReturns"/>
|
||||||
|
<rule ref="category/java/design.xml/SimplifyConditional"/>
|
||||||
|
<rule ref="category/java/design.xml/SingularField"/>
|
||||||
|
<rule ref="category/java/design.xml/SwitchDensity"/>
|
||||||
|
<rule ref="category/java/design.xml/TooManyFields"/>
|
||||||
|
<rule ref="category/java/design.xml/TooManyMethods"/>
|
||||||
|
<rule ref="category/java/design.xml/UselessOverridingMethod"/>
|
||||||
|
<rule ref="category/java/design.xml/UseObjectForClearerAPI"/>
|
||||||
|
<rule ref="category/java/design.xml/UseUtilityClass"/>
|
||||||
|
<rule ref="category/java/documentation.xml/CommentContent"/>
|
||||||
|
<rule ref="category/java/documentation.xml/CommentRequired">
|
||||||
|
<properties>
|
||||||
|
<property name="fieldCommentRequirement" value="Ignored"/>
|
||||||
|
</properties>
|
||||||
|
</rule>
|
||||||
|
<rule ref="category/java/documentation.xml/CommentSize">
|
||||||
|
<properties>
|
||||||
|
<property name="maxLines" value="40"/>
|
||||||
|
</properties>
|
||||||
|
</rule>
|
||||||
|
<rule ref="category/java/documentation.xml/UncommentedEmptyConstructor"/>
|
||||||
|
<rule ref="category/java/documentation.xml/UncommentedEmptyMethodBody"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AssignmentInOperand"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AssignmentToNonFinalStatic"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidAccessibilityAlteration"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidAssertAsIdentifier"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidBranchingStatementAsLastInLoop"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidCallingFinalize"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidCatchingNPE"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidCatchingThrowable"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidDecimalLiteralsInBigDecimalConstructor"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidEnumAsIdentifier"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidFieldNameMatchingMethodName"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidFieldNameMatchingTypeName"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidInstanceofChecksInCatchClause"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidLiteralsInIfCondition"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidLosingExceptionInformation"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidMultipleUnaryOperators"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/AvoidUsingOctalValues"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/BrokenNullCheck"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CallSuperFirst"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CallSuperLast"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CheckSkipResult"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ClassCastExceptionWithToArray"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CloneMethodMustBePublic"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CloneMethodMustImplementCloneable"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CloneMethodReturnTypeMustMatchClassName"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CloseResource"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/CompareObjectsWithEquals"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ComparisonWithNaN"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ConfusingArgumentToVarargsMethod"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ConstructorCallsOverridableMethod"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DetachedTestCase"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DoNotCallGarbageCollectionExplicitly"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DoNotExtendJavaLangThrowable"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DoNotHardCodeSDCard"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DoNotTerminateVM"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DoNotThrowExceptionInFinally"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DontImportSun"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/DontUseFloatTypeForLoopIndices"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/EmptyCatchBlock"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/EmptyFinalizer"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/EqualsNull"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/FinalizeDoesNotCallSuperFinalize"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/FinalizeOnlyCallsSuperFinalize"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/FinalizeOverloaded"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/FinalizeShouldBeProtected"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/IdempotentOperations"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ImplicitSwitchFallThrough"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/InstantiationToGetClass"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/InvalidLogMessageFormat"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/JumbledIncrementer"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/JUnitSpelling"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/JUnitStaticSuite"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/MethodWithSameNameAsEnclosingClass"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/MisplacedNullCheck"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/MissingSerialVersionUID"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/MissingStaticMethodInNonInstantiatableClass"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/MoreThanOneLogger"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/NonCaseLabelInSwitch"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/NonSerializableClass"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/NonStaticInitializer"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/NullAssignment"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/OverrideBothEqualsAndHashcode"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ProperCloneImplementation"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ProperLogger"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ReturnEmptyCollectionRatherThanNull"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/ReturnFromFinallyBlock"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/SimpleDateFormatNeedsLocale"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/SingleMethodSingleton"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/SingletonClassReturningNewInstance"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/StaticEJBFieldShouldBeFinal"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/StringBufferInstantiationWithChar"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/SuspiciousEqualsMethodName"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/SuspiciousHashcodeMethodName"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/SuspiciousOctalEscape"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/TestClassWithoutTestCases"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UnconditionalIfStatement"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UnnecessaryBooleanAssertion"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UnnecessaryCaseChange"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UnnecessaryConversionTemporary"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UnusedNullCheckInEquals"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UseCorrectExceptionLogging"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UseEqualsToCompareStrings"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UselessOperationOnImmutable"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UseLocaleWithCaseConversions"/>
|
||||||
|
<rule ref="category/java/errorprone.xml/UseProperClassLoader"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/AvoidSynchronizedAtMethodLevel"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/AvoidSynchronizedStatement"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/AvoidThreadGroup"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/AvoidUsingVolatile"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/DoNotUseThreads"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/DontCallThreadRun"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/DoubleCheckedLocking"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/NonThreadSafeSingleton"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/UnsynchronizedStaticFormatter"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/UseConcurrentHashMap"/>
|
||||||
|
<rule ref="category/java/multithreading.xml/UseNotifyAllInsteadOfNotify"/>
|
||||||
|
<rule ref="category/java/performance.xml/AddEmptyString"/>
|
||||||
|
<rule ref="category/java/performance.xml/AppendCharacterWithChar"/>
|
||||||
|
<rule ref="category/java/performance.xml/AvoidArrayLoops"/>
|
||||||
|
<rule ref="category/java/performance.xml/AvoidCalendarDateCreation"/>
|
||||||
|
<rule ref="category/java/performance.xml/AvoidFileStream"/>
|
||||||
|
<rule ref="category/java/performance.xml/AvoidInstantiatingObjectsInLoops"/>
|
||||||
|
<rule ref="category/java/performance.xml/BigIntegerInstantiation"/>
|
||||||
|
<rule ref="category/java/performance.xml/ConsecutiveAppendsShouldReuse"/>
|
||||||
|
<rule ref="category/java/performance.xml/ConsecutiveLiteralAppends"/>
|
||||||
|
<rule ref="category/java/performance.xml/InefficientEmptyStringCheck"/>
|
||||||
|
<rule ref="category/java/performance.xml/InefficientStringBuffering"/>
|
||||||
|
<rule ref="category/java/performance.xml/InsufficientStringBufferDeclaration"/>
|
||||||
|
<rule ref="category/java/performance.xml/OptimizableToArrayCall"/>
|
||||||
|
<rule ref="category/java/performance.xml/RedundantFieldInitializer"/>
|
||||||
|
<rule ref="category/java/performance.xml/StringInstantiation"/>
|
||||||
|
<rule ref="category/java/performance.xml/StringToString"/>
|
||||||
|
<rule ref="category/java/performance.xml/TooFewBranchesForSwitch"/>
|
||||||
|
<rule ref="category/java/performance.xml/UseArrayListInsteadOfVector"/>
|
||||||
|
<rule ref="category/java/performance.xml/UseArraysAsList"/>
|
||||||
|
<rule ref="category/java/performance.xml/UseIndexOfChar"/>
|
||||||
|
<rule ref="category/java/performance.xml/UseIOStreamsWithApacheCommonsFileItem"/>
|
||||||
|
<rule ref="category/java/performance.xml/UselessStringValueOf"/>
|
||||||
|
<rule ref="category/java/performance.xml/UseStringBufferForStringAppends"/>
|
||||||
|
<rule ref="category/java/performance.xml/UseStringBufferLength"/>
|
||||||
|
<rule ref="category/java/security.xml/HardCodedCryptoKey"/>
|
||||||
|
<rule ref="category/java/security.xml/InsecureCryptoIv"/>
|
||||||
|
</ruleset>
|
||||||
25
README.md
25
README.md
@@ -12,3 +12,28 @@ values and react to their changes in a clean and decoupled way.
|
|||||||
- Publish/subscribe event bus for listening to value changes
|
- Publish/subscribe event bus for listening to value changes
|
||||||
- Simple API for easy integration into existing projects
|
- Simple API for easy integration into existing projects
|
||||||
- Enables modular design by decoupling components through events
|
- Enables modular design by decoupling components through events
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Add to your `build.gradle`:
|
||||||
|
```groovy
|
||||||
|
repositories {
|
||||||
|
|
||||||
|
maven {
|
||||||
|
name = "GiteaMaven"
|
||||||
|
url = uri("https://gitea.egothor.org/api/packages/Egothor/maven")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use Maven Central for resolving dependencies.
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation 'org.egothor:conflux:x.x.x'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- [Conflux JavaDoc](https://www.egothor.org/javadoc/conflux/)
|
||||||
|
- [Conflux Wiki](https://gitea.egothor.org/Egothor/conflux/wiki)
|
||||||
|
|||||||
54
build.gradle
54
build.gradle
@@ -3,8 +3,13 @@ plugins {
|
|||||||
id 'java-library'
|
id 'java-library'
|
||||||
id 'maven-publish'
|
id 'maven-publish'
|
||||||
id 'com.palantir.git-version' version '4.0.0'
|
id 'com.palantir.git-version' version '4.0.0'
|
||||||
|
id 'pmd'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
import java.time.LocalDate
|
||||||
|
|
||||||
|
def currentYear=LocalDate.now().getYear()
|
||||||
|
|
||||||
group 'org.egothor'
|
group 'org.egothor'
|
||||||
version gitVersion(prefix:'release@')
|
version gitVersion(prefix:'release@')
|
||||||
|
|
||||||
@@ -20,6 +25,13 @@ dependencies {
|
|||||||
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pmd {
|
||||||
|
consoleOutput = true
|
||||||
|
toolVersion = '7.16.0'
|
||||||
|
sourceSets = [sourceSets.main]
|
||||||
|
ruleSetFiles = files(rootProject.file(".ruleset"))
|
||||||
|
}
|
||||||
|
|
||||||
// Apply a specific Java toolchain to ease working on different environments.
|
// Apply a specific Java toolchain to ease working on different environments.
|
||||||
java {
|
java {
|
||||||
toolchain {
|
toolchain {
|
||||||
@@ -32,15 +44,51 @@ java {
|
|||||||
|
|
||||||
javadoc {
|
javadoc {
|
||||||
failOnError = false
|
failOnError = false
|
||||||
}
|
|
||||||
|
options.addBooleanOption('html5', true)
|
||||||
|
options.tags('apiNote:a:API Note:')
|
||||||
|
options.tags('implSpec:a:Implementation Requirements:')
|
||||||
|
options.tags('implNote:a:Implementation Note:')
|
||||||
|
options.tags('param')
|
||||||
|
options.tags('return')
|
||||||
|
options.tags('throws')
|
||||||
|
options.tags('since')
|
||||||
|
options.tags('version')
|
||||||
|
options.tags('serialData')
|
||||||
|
options.tags('factory')
|
||||||
|
options.tags('see')
|
||||||
|
|
||||||
|
options.use = true
|
||||||
|
options.author = true
|
||||||
|
options.version = true
|
||||||
|
options.windowTitle = 'Conflux'
|
||||||
|
|
||||||
|
options.bottom = '<div style="text-align: right; padding: 5px;">Copyright © ' + currentYear +
|
||||||
|
' Egothor - Version ' + version +
|
||||||
|
' - <a href="https://gitea.egothor.org/Egothor/conflux/raw/branch/main/LICENSE">License</a>' +
|
||||||
|
'</div>'
|
||||||
|
source = sourceSets.main.allJava}
|
||||||
|
|
||||||
tasks.named('test') {
|
tasks.named('test') {
|
||||||
// Use JUnit Platform for unit tests.
|
// Use JUnit Platform for unit tests.
|
||||||
useJUnitPlatform()
|
useJUnitPlatform()
|
||||||
}
|
}
|
||||||
|
|
||||||
tasks.withType(Javadoc).configureEach {
|
task uploadJavadoc(type: Exec) {
|
||||||
options.bottom = "Copyright © 2025 Egothor"
|
dependsOn javadoc
|
||||||
|
|
||||||
|
doFirst {
|
||||||
|
def javadocDir = tasks.javadoc.destinationDir
|
||||||
|
def relativeJavadocDir = project.projectDir.toPath().relativize(javadocDir.toPath()).toString()
|
||||||
|
|
||||||
|
println "Uploading Javadoc with key: ${javadocKeyPath}"
|
||||||
|
println " from relative path: $relativeJavadocDir"
|
||||||
|
|
||||||
|
commandLine "rsync", "-avz", "--delete",
|
||||||
|
"-e", "ssh -i ${javadocKeyPath} -o IdentitiesOnly=yes",
|
||||||
|
relativeJavadocDir + '/', "${javadocUser}@${javadocHost}:${javadocPath}"
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (project.hasProperty('giteaToken') && project.giteaToken) {
|
if (project.hasProperty('giteaToken') && project.giteaToken) {
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
javadocPath=/var/www/html/javadoc/conflux/
|
||||||
@@ -85,6 +85,46 @@ public enum Ctx implements CtxInterface {
|
|||||||
return contexts.computeIfAbsent(name, k -> new CtxInstance());
|
return contexts.computeIfAbsent(name, k -> new CtxInstance());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes a named context previously created via {@link #getContext(String)}.
|
||||||
|
* <p>
|
||||||
|
* The context is atomically removed from the internal registry and then
|
||||||
|
* {@linkplain CtxInterface#clear() cleared} to release stored values and
|
||||||
|
* listener references. This operation is thread-safe and idempotent: if the
|
||||||
|
* specified context does not exist, the method returns {@code false} and
|
||||||
|
* performs no action.
|
||||||
|
* </p>
|
||||||
|
* <p>
|
||||||
|
* Calling {@code getContext(name)} again after a successful removal will create
|
||||||
|
* a brand-new, empty context. The default/global context represented by
|
||||||
|
* {@link #INSTANCE} is not affected.
|
||||||
|
* </p>
|
||||||
|
*
|
||||||
|
* @param name the name of the context to remove; must not be {@code null} or
|
||||||
|
* blank
|
||||||
|
* @return {@code true} if a context with the given name existed and was
|
||||||
|
* removed; {@code false} otherwise
|
||||||
|
* @throws IllegalArgumentException if {@code name} is {@code null} or blank
|
||||||
|
* @implNote Uses {@link ConcurrentHashMap#remove(Object)} for atomic removal,
|
||||||
|
* then invokes {@link CtxInterface#clear()} on the removed instance.
|
||||||
|
* @since 2025.08
|
||||||
|
*/
|
||||||
|
public boolean removeContext(String name) {
|
||||||
|
if (name == null || name.isBlank()) {
|
||||||
|
throw new IllegalArgumentException("name must not be null or blank");
|
||||||
|
}
|
||||||
|
CtxInterface ctx = contexts.remove(name);
|
||||||
|
final boolean existed = ctx != null;
|
||||||
|
if (existed) {
|
||||||
|
try {
|
||||||
|
ctx.clear();
|
||||||
|
} catch (RuntimeException ignore) { // NOPMD
|
||||||
|
// Best-effort cleanup; deregistration already succeeded.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return existed;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the set of names for all currently registered contexts.
|
* Returns the set of names for all currently registered contexts.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -62,6 +62,16 @@ public final class CtxInstance implements CtxInterface {
|
|||||||
private final Map<String, Class<?>> keyTypes = new ConcurrentHashMap<>();
|
private final Map<String, Class<?>> keyTypes = new ConcurrentHashMap<>();
|
||||||
private final Map<Key<?>, List<WeakReference<Listener<?>>>> listeners = new ConcurrentHashMap<>();
|
private final Map<Key<?>, List<WeakReference<Listener<?>>>> listeners = new ConcurrentHashMap<>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Protected no-argument constructor added to satisfy code analysis tools.
|
||||||
|
* <p>
|
||||||
|
* This constructor should not be used directly. It exists solely to comply with
|
||||||
|
* static analysis requirements (e.g., PMD) expecting at least one constructor.
|
||||||
|
*/
|
||||||
|
protected CtxInstance() {
|
||||||
|
// Intentionally left blank
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stores or updates the value for a given key. If the key is used for the first
|
* Stores or updates the value for a given key. If the key is used for the first
|
||||||
* time, its type is recorded. If the key has been used before with a different
|
* time, its type is recorded. If the key has been used before with a different
|
||||||
@@ -98,10 +108,10 @@ public final class CtxInstance implements CtxInterface {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// notify listeners
|
// notify listeners
|
||||||
var list = listeners.get(key);
|
List<WeakReference<Listener<?>>> list = listeners.get(key);
|
||||||
if (list != null) {
|
if (list != null) {
|
||||||
for (var ref : list) {
|
for (WeakReference<Listener<?>> ref : list) {
|
||||||
var listener = ref.get();
|
Listener<?> listener = ref.get();
|
||||||
if (listener != null) {
|
if (listener != null) {
|
||||||
@SuppressWarnings("unchecked")
|
@SuppressWarnings("unchecked")
|
||||||
Listener<T> typedListener = (Listener<T>) listener;
|
Listener<T> typedListener = (Listener<T>) listener;
|
||||||
@@ -146,7 +156,7 @@ public final class CtxInstance implements CtxInterface {
|
|||||||
@Override
|
@Override
|
||||||
public Object remove(Key<?> key) {
|
public Object remove(Key<?> key) {
|
||||||
keyTypes.remove(key.name());
|
keyTypes.remove(key.name());
|
||||||
var removed = values.remove(key);
|
Object removed = values.remove(key);
|
||||||
listeners.remove(key);
|
listeners.remove(key);
|
||||||
return removed;
|
return removed;
|
||||||
}
|
}
|
||||||
@@ -183,10 +193,10 @@ public final class CtxInstance implements CtxInterface {
|
|||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public <T> void removeListener(Key<T> key, Listener<T> listener) {
|
public <T> void removeListener(Key<T> key, Listener<T> listener) {
|
||||||
var list = listeners.get(key);
|
List<WeakReference<Listener<?>>> list = listeners.get(key);
|
||||||
if (list != null) {
|
if (list != null) {
|
||||||
list.removeIf(ref -> {
|
list.removeIf(ref -> {
|
||||||
var l = ref.get();
|
Listener<?> l = ref.get();
|
||||||
return l == null || l.equals(listener);
|
return l == null || l.equals(listener);
|
||||||
});
|
});
|
||||||
if (list.isEmpty()) {
|
if (list.isEmpty()) {
|
||||||
|
|||||||
@@ -42,19 +42,19 @@ package conflux;
|
|||||||
* @author Leo Galambos
|
* @author Leo Galambos
|
||||||
*/
|
*/
|
||||||
public final class Key<T> { // NOPMD by Leo Galambos on 7/3/25, 10:29 PM
|
public final class Key<T> { // NOPMD by Leo Galambos on 7/3/25, 10:29 PM
|
||||||
private final String name;
|
private final String nameField;
|
||||||
private final Class<T> type;
|
private final Class<T> typeField;
|
||||||
|
|
||||||
private Key(String name, Class<T> type) {
|
private Key(String name, Class<T> type) {
|
||||||
this.name = name;
|
this.nameField = name;
|
||||||
this.type = type;
|
this.typeField = type;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new typed key.
|
* Creates a new typed key.
|
||||||
*
|
*
|
||||||
* @param name a unique key name
|
* @param name a unique key nameField
|
||||||
* @param type the class of the key's value type
|
* @param type the class of the key's value typeField
|
||||||
* @param <T> the type
|
* @param <T> the type
|
||||||
* @return a new {@code Key}
|
* @return a new {@code Key}
|
||||||
*/
|
*/
|
||||||
@@ -68,7 +68,7 @@ public final class Key<T> { // NOPMD by Leo Galambos on 7/3/25, 10:29 PM
|
|||||||
* @return the name
|
* @return the name
|
||||||
*/
|
*/
|
||||||
public String name() {
|
public String name() {
|
||||||
return name;
|
return nameField;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -77,21 +77,21 @@ public final class Key<T> { // NOPMD by Leo Galambos on 7/3/25, 10:29 PM
|
|||||||
* @return the type
|
* @return the type
|
||||||
*/
|
*/
|
||||||
public Class<T> type() {
|
public Class<T> type() {
|
||||||
return type;
|
return typeField;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public int hashCode() {
|
public int hashCode() {
|
||||||
return name.hashCode();
|
return nameField.hashCode();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean equals(Object obj) {
|
public boolean equals(Object obj) {
|
||||||
return obj instanceof Key<?> other && name.equals(other.name);
|
return obj instanceof Key<?> other && nameField.equals(other.nameField);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String toString() {
|
public String toString() {
|
||||||
return "Key[" + name + ", " + type.getSimpleName() + "]";
|
return "Key[" + nameField + ", " + typeField.getSimpleName() + "]";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Reference in New Issue
Block a user