View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.workflow.api;
23  
24  import java.util.Objects;
25  
26  /**
27   * Represents a workflow's "primary key", for use in maps and sets (immutable)
28   */
29  public final class WorkflowIdentifier {
30    private final String id;
31    private final String organization;
32  
33    public WorkflowIdentifier(String id, String organization) {
34      this.id = id;
35      this.organization = organization;
36    }
37  
38    public String getId() {
39      return id;
40    }
41  
42    public String getOrganization() {
43      return organization;
44    }
45  
46    @Override
47    public boolean equals(Object o) {
48      if (this == o)
49        return true;
50      if (o == null || getClass() != o.getClass())
51        return false;
52      WorkflowIdentifier that = (WorkflowIdentifier) o;
53      return id.equals(that.id) && Objects.equals(organization, that.organization);
54    }
55  
56    @Override
57    public int hashCode() {
58      return Objects.hash(id, organization);
59    }
60  
61    public String toString() {
62      if (organization == null) {
63        return id;
64      }
65      return String.format("%s/%s", organization, id);
66    }
67  
68    /**
69     * Return a new identifier without an organization (idempotent)
70     * @return See above
71     */
72    public WorkflowIdentifier withoutOrganization() {
73      return new WorkflowIdentifier(id, null);
74    }
75  }