Merge pull request #729 from xlegalles/CleanUpCode1

Reformat Client/API: use file-scope namespace and primary constructor

Client/Api/Responses/IPublishMessageResponse.cs

@@ -1,9 +1,6 @@
-namespace Zeebe.Client.Api.Responses
-{
-    /// <summary>
-    /// Response for publishing a message.
-    /// </summary>
-    public interface IPublishMessageResponse
-    {
-    }
-}
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// Response for publishing a message.
+/// </summary>
+public interface IPublishMessageResponse;

Client/Api/Responses/IResolveIncidentResponse.cs

@@ -1,9 +1,6 @@
-namespace Zeebe.Client.Api.Responses
-{
-    /// <summary>
-    /// Response for an resolve incident request.
-    /// </summary>
-    public interface IResolveIncidentResponse
-    {
-    }
-}
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// Response for an resolve incident request.
+/// </summary>
+public interface IResolveIncidentResponse;

Client/Api/Responses/ISetVariablesResponse.cs

@@ -1,11 +1,10 @@
-namespace Zeebe.Client.Api.Responses
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// Response for an set variables request.
+/// </summary>
+public interface ISetVariablesResponse
 {
-    /// <summary>
-    /// Response for an set variables request.
-    /// </summary>
-    public interface ISetVariablesResponse
-    {
-        /// <returns> The unique key of the command</returns>
-        long Key { get; }
-    }
+    /// <returns> The unique key of the command</returns>
+    long Key { get; }
 }

Client/Api/Responses/IThrowErrorResponse.cs

@@ -1,9 +1,6 @@
-namespace Zeebe.Client.Api.Responses
-{
-    /// <summary>
-    /// Response for an throw error request.
-    /// </summary>
-    public interface IThrowErrorResponse
-    {
-    }
-}
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// Response for an throw error request.
+/// </summary>
+public interface IThrowErrorResponse;

Client/Api/Responses/ITopology.cs

@@ -14,18 +14,17 @@
 //    limitations under the License.
 using System.Collections.Generic;
 
-namespace Zeebe.Client.Api.Responses
+namespace Zeebe.Client.Api.Responses;
+
+public interface ITopology
 {
-    public interface ITopology
-    {
-        /// <returns>
-        /// All (known) brokers of the cluster
-        /// </returns>
-        IList<IBrokerInfo> Brokers { get; }
+    /// <returns>
+    /// All (known) brokers of the cluster
+    /// </returns>
+    IList<IBrokerInfo> Brokers { get; }
 
-        /// <returns>
-        /// The gateway version or 'lower then 0.23' if none was found.
-        /// </returns>
-        string GatewayVersion { get; }
-    }
-}
+    /// <returns>
+    /// The gateway version or 'lower then 0.23' if none was found.
+    /// </returns>
+    string GatewayVersion { get; }
+}

Client/Api/Responses/IUpdateJobTimeoutResponse.cs

@@ -1,9 +1,6 @@
-namespace Zeebe.Client.Api.Responses
-{
-    /// <summary>
-    /// Response for an update job timeout request.
-    /// </summary>
-    public interface IUpdateJobTimeoutResponse
-    {
-    }
-}
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// Response for an update job timeout request.
+/// </summary>
+public interface IUpdateJobTimeoutResponse;

Client/Api/Responses/IUpdateRetriesResponse.cs

@@ -1,9 +1,8 @@
-namespace Zeebe.Client.Api.Responses
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// Response for an update retries request.
+/// </summary>
+public interface IUpdateRetriesResponse
 {
-    /// <summary>
-    /// Response for an update retries request.
-    /// </summary>
-    public interface IUpdateRetriesResponse
-    {
-    }
 }

Client/Api/Responses/PartitionBrokerRole.cs

@@ -12,14 +12,13 @@
 //    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 //    See the License for the specific language governing permissions and
 //    limitations under the License.
-namespace Zeebe.Client.Api.Responses
+namespace Zeebe.Client.Api.Responses;
+
+/// <summary>
+/// The RAFT role of the broker either LEADER or FOLLOWER.
+/// </summary>
+public enum PartitionBrokerRole
 {
-    /// <summary>
-    /// The RAFT role of the broker either LEADER or FOLLOWER.
-    /// </summary>
-    public enum PartitionBrokerRole
-    {
-        LEADER,
-        FOLLOWER
-    }
-}
+    LEADER,
+    FOLLOWER
+}

Client/Api/Worker/IJobClient.cs

@@ -16,104 +16,103 @@
 using Zeebe.Client.Api.Commands;
 using Zeebe.Client.Api.Responses;
 
-namespace Zeebe.Client.Api.Worker
+namespace Zeebe.Client.Api.Worker;
+
+/// <summary>
+/// A client with access to all job-related operation:
+/// <list type="bullet">
+///   <item>complete a job</item>
+///   <item> mark a job as failed</item>
+///   <item> update the retries of a job</item>
+/// </list>
+/// </summary>
+public interface IJobClient
 {
     /// <summary>
-    /// A client with access to all job-related operation:
-    /// <list type="bullet">
-    ///   <item>complete a job</item>
-    ///   <item> mark a job as failed</item>
-    ///   <item> update the retries of a job</item>
-    /// </list>
+    /// Command to complete a job.
     /// </summary>
-    public interface IJobClient
-    {
-        /// <summary>
-        /// Command to complete a job.
-        /// </summary>
-        /// <example>
-        /// <code>
-        /// long jobKey = ..;
-        ///
-        /// jobClient
-        ///      .NewCompleteJobCommand(jobKey)
-        ///      .Variables(json)
-        ///      .Send();
-        /// </code>
-        /// </example>
-        ///
-        /// <para>
-        ///     The job is linked to a process instance, which means this command will complete the related
-        ///     activity and continue the flow.
-        /// </para>
-        ///
-        /// <param name="jobKey">the key which identifies the job</param>
-        /// <returns>a builder for the command</returns>
-        ICompleteJobCommandStep1 NewCompleteJobCommand(long jobKey);
+    /// <example>
+    /// <code>
+    /// long jobKey = ..;
+    ///
+    /// jobClient
+    ///      .NewCompleteJobCommand(jobKey)
+    ///      .Variables(json)
+    ///      .Send();
+    /// </code>
+    /// </example>
+    ///
+    /// <para>
+    ///     The job is linked to a process instance, which means this command will complete the related
+    ///     activity and continue the flow.
+    /// </para>
+    ///
+    /// <param name="jobKey">the key which identifies the job</param>
+    /// <returns>a builder for the command</returns>
+    ICompleteJobCommandStep1 NewCompleteJobCommand(long jobKey);
 
-        /// <summary>
-        /// Command to complete a job.
-        /// </summary>
-        ///
-        /// <example>
-        /// <code>
-        /// IJob activatedJob = ..;
-        ///
-        /// jobClient
-        ///      .NewCompleteJobCommand(activatedJob)
-        ///      .Variables(json)
-        ///      .Send();
-        /// </code>
-        /// </example>
-        ///
-        /// <para>
-        ///     The job is linked to a process instance, which means this command will complete the related
-        ///     activity and continue the flow.
-        /// </para>
-        ///
-        /// <param name="activatedJob">the job, which should be completed</param>
-        /// <returns>a builder for the command</returns>
-        ICompleteJobCommandStep1 NewCompleteJobCommand(IJob activatedJob);
+    /// <summary>
+    /// Command to complete a job.
+    /// </summary>
+    ///
+    /// <example>
+    /// <code>
+    /// IJob activatedJob = ..;
+    ///
+    /// jobClient
+    ///      .NewCompleteJobCommand(activatedJob)
+    ///      .Variables(json)
+    ///      .Send();
+    /// </code>
+    /// </example>
+    ///
+    /// <para>
+    ///     The job is linked to a process instance, which means this command will complete the related
+    ///     activity and continue the flow.
+    /// </para>
+    ///
+    /// <param name="activatedJob">the job, which should be completed</param>
+    /// <returns>a builder for the command</returns>
+    ICompleteJobCommandStep1 NewCompleteJobCommand(IJob activatedJob);
 
-        /// <summary>
-        /// Command to mark a job as failed.
-        /// </summary>
-        ///
-        /// <example>
-        /// <code>
-        /// long jobKey = ..;
-        ///
-        /// jobClient
-        ///      .NewFailCommand(jobKey)
-        ///      .Retries(3)
-        ///      .Send();
-        /// </code>
-        /// </example>
-        ///
-        /// <para>
-        ///     If the given retries are greater than zero then this job will be picked up again by a job
-        ///     worker. Otherwise, an incident is created for this job.
-        /// </para>
-        /// <param name="jobKey">the key which identifies the job</param>
-        /// <returns>a builder for the command</returns>
-        IFailJobCommandStep1 NewFailCommand(long jobKey);
+    /// <summary>
+    /// Command to mark a job as failed.
+    /// </summary>
+    ///
+    /// <example>
+    /// <code>
+    /// long jobKey = ..;
+    ///
+    /// jobClient
+    ///      .NewFailCommand(jobKey)
+    ///      .Retries(3)
+    ///      .Send();
+    /// </code>
+    /// </example>
+    ///
+    /// <para>
+    ///     If the given retries are greater than zero then this job will be picked up again by a job
+    ///     worker. Otherwise, an incident is created for this job.
+    /// </para>
+    /// <param name="jobKey">the key which identifies the job</param>
+    /// <returns>a builder for the command</returns>
+    IFailJobCommandStep1 NewFailCommand(long jobKey);
 
-        /// <summary>
-        /// Command to report a business error (i.e. non-technical) that occurs while processing a job.
-        /// </summary>
-        /// <example>
-        /// <code>
-        ///  long jobKey = ...;
-        ///  string code = ...;
-        ///  jobClient
-        ///     .NewThrowErrorCommand(jobKey)
-        ///     .ErrorCode(code)
-        ///     .ErrorMessage("Business error message")
-        ///     .Send();
-        /// </code>
-        /// </example>
-        /// <param name="jobKey">the key which identifies the job</param>
-        /// <returns>a builder for the command</returns>
-        IThrowErrorCommandStep1 NewThrowErrorCommand(long jobKey);
-    }
-}
+    /// <summary>
+    /// Command to report a business error (i.e. non-technical) that occurs while processing a job.
+    /// </summary>
+    /// <example>
+    /// <code>
+    ///  long jobKey = ...;
+    ///  string code = ...;
+    ///  jobClient
+    ///     .NewThrowErrorCommand(jobKey)
+    ///     .ErrorCode(code)
+    ///     .ErrorMessage("Business error message")
+    ///     .Send();
+    /// </code>
+    /// </example>
+    /// <param name="jobKey">the key which identifies the job</param>
+    /// <returns>a builder for the command</returns>
+    IThrowErrorCommandStep1 NewThrowErrorCommand(long jobKey);
+}

Client/Api/Worker/IJobWorker.cs

@@ -14,19 +14,18 @@
 //    limitations under the License.
 using System;
 
-namespace Zeebe.Client.Api.Worker
+namespace Zeebe.Client.Api.Worker;
+
+/// <summary>
+/// Represents an job worker that performs jobs of a certain type. While a registration is
+/// open, the worker continuously receives jobs from the broker and hands them to a registered
+/// <see cref="JobHandler"/>.
+/// </summary>
+public interface IJobWorker : IDisposable
 {
-    /// <summary>
-    /// Represents an job worker that performs jobs of a certain type. While a registration is
-    /// open, the worker continuously receives jobs from the broker and hands them to a registered
-    /// <see cref="JobHandler"/>.
-    /// </summary>
-    public interface IJobWorker : IDisposable
-    {
-        /// <returns>true if this registration is currently active and work items are being received for it</returns>
-        bool IsOpen();
+    /// <returns>true if this registration is currently active and work items are being received for it</returns>
+    bool IsOpen();
 
-        /// <returns>true if this registration is not open and is not in the process of opening or closing</returns>
-        bool IsClosed();
-    }
+    /// <returns>true if this registration is not open and is not in the process of opening or closing</returns>
+    bool IsClosed();
 }