org.turro.phase.PhaseDefinition Class Reference

Inheritance diagram for org.turro.phase.PhaseDefinition:

Collaboration diagram for org.turro.phase.PhaseDefinition:

Public Member Functions
PhaseDefinition	icon (String icon)
PhaseDefinition	described (String description)
PhaseDefinition	addMapping (String targetEntity, Integer targetPhase)
PhaseDefinition	addDocumentation (String documentation)
PhaseDefinition	addPermission (ConceptPermission permission)
int	getIndex ()
String	getName ()
Set< PhaseType >	getTypes ()
boolean	anyStringMatch (Collection< String > types)
boolean	anyTypeMatch (Collection< PhaseType > types)
String	getIconName ()
String	getDescription ()
Map< String, Integer >	getMapping ()
Set< String >	getDocumentation ()
ConceptPermission	getPermission (String name, IElephantEntity iee)
Collection< String >	getConcepts ()
int	compareTo (PhaseDefinition o)

Static Public Member Functions
static PhaseDefinition	create (int index, String name, Set< PhaseType > types)

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 36 of file PhaseDefinition.java.

Member Function Documentation

addDocumentation()

PhaseDefinition org.turro.phase.PhaseDefinition.addDocumentation

(

String

documentation

)

Definition at line 63 of file PhaseDefinition.java.

                                                                {
    this.documentation.add(documentation);
    return this;
  }

addMapping()

PhaseDefinition org.turro.phase.PhaseDefinition.addMapping	(	String	targetEntity,
		Integer	targetPhase
	)

Definition at line 58 of file PhaseDefinition.java.

                                                                              {
    this.mapping.put(targetEntity, targetPhase);
    return this;
  }

addPermission()

PhaseDefinition org.turro.phase.PhaseDefinition.addPermission

(

ConceptPermission

permission

)

Definition at line 68 of file PhaseDefinition.java.

                                                                     {
    permissions.put(permission);
    return this;
  }

Here is the call graph for this function:

anyStringMatch()

boolean org.turro.phase.PhaseDefinition.anyStringMatch

(

Collection< String >

types

)

Definition at line 85 of file PhaseDefinition.java.

                                                          {
    return anyTypeMatch(types.stream().map(t -> PhaseType.valueOf(t)).toList());
  }

Here is the call graph for this function:

anyTypeMatch()

boolean org.turro.phase.PhaseDefinition.anyTypeMatch

(

Collection< PhaseType >

types

)

Definition at line 89 of file PhaseDefinition.java.

                                                           {
    return this.types.stream().anyMatch(types::contains);
  }

Here is the caller graph for this function:

compareTo()

int org.turro.phase.PhaseDefinition.compareTo

(

PhaseDefinition

o

)

Definition at line 120 of file PhaseDefinition.java.

                                          {
    int result = Integer.compare(index, o.index);
    if(result == 0) {
      result = CompareUtil.compare(name, o.name);
    }
    return result;
  }

create()

static PhaseDefinition org.turro.phase.PhaseDefinition.create ( int  index, String  name, Set< PhaseType >  types  )

static

Definition at line 130 of file PhaseDefinition.java.

                                                                                     {
    return new PhaseDefinition(index, name, types);
  }

described()

PhaseDefinition org.turro.phase.PhaseDefinition.described

(

String

description

)

Definition at line 53 of file PhaseDefinition.java.

                                                       {
    this.description = description;
    return this;
  }

getConcepts()

Collection<String> org.turro.phase.PhaseDefinition.getConcepts

(

)

Definition at line 113 of file PhaseDefinition.java.

                                          {
    return permissions.concepts();
  }

Here is the call graph for this function:

getDescription()

String org.turro.phase.PhaseDefinition.getDescription

(

)

Definition at line 97 of file PhaseDefinition.java.

                                 {
    return description;
  }

getDocumentation()

Set<String> org.turro.phase.PhaseDefinition.getDocumentation

(

)

Definition at line 105 of file PhaseDefinition.java.

                                        {
    return documentation;
  }

getIconName()

String org.turro.phase.PhaseDefinition.getIconName

(

)

Definition at line 93 of file PhaseDefinition.java.

                              {
    return icon;
  }

getIndex()

int org.turro.phase.PhaseDefinition.getIndex

(

)

Definition at line 73 of file PhaseDefinition.java.

                        {
    return index;
  }

Here is the caller graph for this function:

getMapping()

Map<String, Integer> org.turro.phase.PhaseDefinition.getMapping

(

)

Definition at line 101 of file PhaseDefinition.java.

                                           {
    return mapping;
  }

Here is the caller graph for this function:

getName()

String org.turro.phase.PhaseDefinition.getName

(

)

Definition at line 77 of file PhaseDefinition.java.

                          {
    return name;
  }

Here is the caller graph for this function:

getPermission()

ConceptPermission org.turro.phase.PhaseDefinition.getPermission	(	String	name,
		IElephantEntity	iee
	)

Definition at line 109 of file PhaseDefinition.java.

                                                                           {
    return Optional.ofNullable(permissions.get(name, iee)).orElse(null);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypes()

Set<PhaseType> org.turro.phase.PhaseDefinition.getTypes

(

)

Definition at line 81 of file PhaseDefinition.java.

                                   {
    return types;
  }

icon()

PhaseDefinition org.turro.phase.PhaseDefinition.icon

(

String

icon

)

Definition at line 48 of file PhaseDefinition.java.

                                           {
    this.icon = icon;
    return this;
  }

---

The documentation for this class was generated from the following file:

• PhaseDefinition.java