CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto.base
Class NamedDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.base.NamedDto
All Implemented Interfaces:
BaseDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
ArtifactApprovalStepDto, ArtifactApprovalWorkflowDto, ArtifactStatusDto, DescribeableDto, DirectoryDto, ForumTypeDto, GroupDto, LabelDto, ProjectDocumentSummaryDto, ReadOnlyNamedDto, SourceDirectoryDto, SourceFileDto, TrackerChoiceOptionDto, TrackerItemHistoryEntryDto, TrackerTypeDto, TrackerViewDto, UserDto, UserKeyDto, WorkflowTransitionDto

public class NamedDto
extends IdentifiableDto

All DTO classes with name property must extend this.

See Also:
Serialized Form

Nested Class Summary
static class NamedDto.NameComparator
          A special Comparator implementation to compare two NamedDtos by name
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Constructor Summary
NamedDto()
           
NamedDto(java.lang.Integer id)
           
NamedDto(java.lang.Integer id, java.lang.String name)
           
NamedDto(NamedDto base)
           
 
Method Summary
static int compareNames(NamedDto n1, NamedDto n2)
           
static int compareString(java.lang.String s1, java.lang.String s2)
           
static int compareStringIgnoreCase(java.lang.String s1, java.lang.String s2)
           
 int compareTo(java.lang.Object obj)
          Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared
static
<T extends NamedDto>
java.util.SortedMap<java.lang.String,T>
createLookupMap(java.util.Collection<T> dtos)
          Create a sorted map to lookup NamedDtos by name.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getName()
          Returns its (descriptive) name.
 int hashCode()
           
 void setName(java.lang.String name)
          Sets its (descriptive) name.
 java.lang.String toString()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
clone, compare, compareInteger, equals, getId, hashCode, setId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NamedDto

public NamedDto()

NamedDto

public NamedDto(java.lang.Integer id)

NamedDto

public NamedDto(java.lang.Integer id,
                java.lang.String name)

NamedDto

public NamedDto(NamedDto base)
Method Detail

getName

public java.lang.String getName()
Returns its (descriptive) name.


setName

public void setName(java.lang.String name)
Sets its (descriptive) name.


equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class IdentifiableDto

hashCode

public int hashCode()
Overrides:
hashCode in class IdentifiableDto

compareTo

public int compareTo(java.lang.Object obj)
Caution: NamedDto compareTo violates the rule that a.equals(b) is equivalent to a.compareTo(b) == 0, because only the names are compared

Specified by:
compareTo in interface java.lang.Comparable
Overrides:
compareTo in class IdentifiableDto

toString

public java.lang.String toString()
Overrides:
toString in class IdentifiableDto

compareNames

public static int compareNames(NamedDto n1,
                               NamedDto n2)

compareString

public static int compareString(java.lang.String s1,
                                java.lang.String s2)

compareStringIgnoreCase

public static int compareStringIgnoreCase(java.lang.String s1,
                                          java.lang.String s2)

createLookupMap

public static <T extends NamedDto> java.util.SortedMap<java.lang.String,T> createLookupMap(java.util.Collection<T> dtos)
Create a sorted map to lookup NamedDtos by name. The names of the dtos in the specified collections should be unique, otherwise only the last dto with a specific name will be retrievable via the map.

Parameters:
dtos - to
Returns:
a sorted map to lookup NamedDtos by name

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.