Take the 2-minute tour ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.

As a fairly green Java coder I've set myself the hefty challenge of trying to write a simple text adventure. Unsurprisingly, I've encountered difficulties already!

I'm trying to give my Location class a property to store which exits it contains. I've used a boolean array for this, to essentially hold true/false values representing each exit. I'm not entirely convinced that

a) this is the most efficient way to do this and

b) that I'm using the right code to populate the array.

I would appreciate any and all feedback, even if it is for a complete code over-haul!

At present, when instantiating a Location I generate a String which I send through to the setExits method:

    String e = "N S U";
    secretRoom.setExits(e);

In the Location class, setExits looks like this:

public void setExits(String e) {
    if (e.contains("N"))
        bexits[0] = true;
    else if (e.contains("W"))
        bexits[1] = true;
    else if (e.contains("S"))
        bexits[2] = true;
    else if (e.contains("E"))
        bexits[3] = true;
    else if (e.contains("U"))
        bexits[4] = true;
    else if (e.contains("D"))
        bexits[5] = true;
}

I'll be honest, I think this looks particularly clunky, but I couldn't think of another way to do it. I'm also not entirely sure now how to write the getExits method...

Any help would be welcome!

share|improve this question
21  
Man, if only all "green" programmers could ask questions this way. May I also suggest codereview for questions like these that only ask for improvement? Good luck. –  MDeSchaepmeester yesterday
    
@MDeSchaepmeester : bad in English...what does green Java coder means?? :o –  NoobEditor yesterday
1  
@NoobEditor - It means 'new'. –  Rudi yesterday
1  
Green is a pretty common English term wisegeek.com/… –  Ross Drew yesterday
1  
Have you chosen this project specifically to learn Java better, or because text adventures are awesome? For the former, good going, you'll learn a lot! But if it's the latter, may I recommend Inform 7 or TADS? –  Paul Z yesterday
show 4 more comments

12 Answers

up vote 13 down vote accepted

Is there any reason why you are doing this with Strings and aren't passing in booleans, i.e.

public void setExits(boolean N, boolean E, boolean S, boolean W, boolean U, boolean D) 

Or having setters?

public void setNorthOpen(boolean open)
{
  bexits[4] = open;
}

Secondly, why are you storing the exits as an array of booleans, it's a small finite set, why not just

boolean N,S,E,W,U,D;

As then you don't need to keep track of which number in the array each direction is.

Also

This is a correct answer (if not completely optimal like that of @gexicide) but I fully encourage anyone to look at the other answers here for an interesting look at how things can be done in Java in different ways.

For future reference

Code which works belongs on Code Review, not Stack Overflow. Although as @kajacx pointed out, this code shouldn't -in fact- work.

share|improve this answer
1  
Thanks @Ross, I like the look of the setters you have suggested. As I mentioned, I am very new to this so I am kind of blundering my way through! Thank you though, I appreciate your help. –  lordchancellor yesterday
2  
Also, thanks for the point about Code Review - I didn't know this but shall remember for future reference. –  lordchancellor yesterday
    
Some of the answers on here are really good if you want to stick with the Strings but unless you have a special reason to do so, I'd suggest moving to all booleans like in my example. –  Ross Drew yesterday
8  
setExits(false, true, false, true) will be horrible to read and the enum variant suggested in another answer is just superior. –  OliverS yesterday
    
I agree, multiple aguments aren't great, that's why I suggested the accessor methods. I also agree that ideally the EnumSet is the nicest option but I had read that the OP was "green" and thought something simple as a stepping stone away from the obviously painful String passing was a better option. I would normally have expanded my answer to be more advanced but @gexicide answered in the meantime and I don't want to answer steal and both are now here for anyone who wants it. Down voting because its not the absolute optimal answer isn't really right though eh? –  Ross Drew 17 hours ago
add comment

The most efficient and expressive way is the following:

Use enums as Exits and use an EnumSet to store them. EnumSet is an efficient Set implementation that uses a bit field to represent the enum constants.

Here is how you can do it:

public enum Exit { North, West, South, East, Up, Down; }

EnumSet<Exit> set = EnumSet.noneOf(Exit.class); // An empty set.

// Now you can simply add or remove exits, everything will be stored compactly

set.add(Exit.North); // Add exit
set.contains(Exit.West); // Test if an exit is present
set.remove(Exit.South); //Remove an exit

Enum set will store all exits in a single long internally, so your code is expressive, fast, and saves a lot of memory.

share|improve this answer
2  
I love the simplicity of this answer! To make the code slightly more readable, I would also make each enum direction the full name, rather than the first letter. I.e public enum Exit { North, West, South, East, Up, Down; } –  Dylan Watson yesterday
    
+1 very clean and readable –  Amir Afghani yesterday
1  
Very elegant solution. I've never seen EnumSet used like this before, but it looks like a great idiom to get used to. –  ValekHalfHeart yesterday
1  
@zamnuts The implementation of EnumSet uses JumboEnumSet if there are too many elements in the Enum. See grepcode.com/file/repository.grepcode.com/java/root/jdk/openjdk/… –  WW. 19 hours ago
1  
@gexicide Agreed, it might be possible. A benchmark would tell us if someone was curious enough. Even when not, I'd think at least twice before using anything but EnumSet here. –  maaartinus 17 hours ago
show 6 more comments

OK, first of all, you setExits() method will not work as intended, chained if-elseif will maximally execute 1 branch of code, for example:

if (e.contains("N"))
    bexits[0] = true;
else if (e.contains("W"))
    bexits[1] = true;

Even if e contains both N and W, only bexits[0] will be set. Also this method will only add exits (for example calling setExits("") will not delete any existing exits.

I would change that method to:

bexits[0] = e.contains("N");
bexits[1] = e.contains("W");
...

Also, i definetly wouldn't remember that north is on index 0, west in on 1, ... so a common practice is to name your indexes using final static constants:

public static final int NORTH = 0;
public static final int WEST = 1;
...

Then you can write in your setExits method:

bexits[NORTH] = e.contains("N");
bexits[WEST] = e.contains("W");
...

(much more readible)

Finally, if you want your code even more well-arranged, you can make a Exits class representing avaliable exits, and backed by boolean array. Then on place where you create your String, you could create this class instead and save yourself work with generating and then parsing a string.

EDIT:

as @gexicide answers, there is a really handy class EnumSet which would be probably better for representing the exits than bollean array.

share|improve this answer
2  
public static final int feels like Java 1.4, and was replaced with enums instead –  Zhuinden yesterday
    
You will use that as index to accsess an array, i like it better than using enum and grabbing enum's id or something to get the index. –  kajacx yesterday
    
That's exactly what my answer used below. Well, it's true that you'd need to use Directions.NORTH.ordinal() for the index of a specific direction... –  Zhuinden yesterday
    
On the other hand, the EnumSet looks really cool, didn't know that class, i'll add it to the answer. –  kajacx yesterday
add comment

I would create an Exit enum and on the location class just set a list of Exit objects.

so it would be something like:

public enum Exit { N, S, E, W, U, D }

List<Exit> exits = parseExits(String exitString);
location.setExits(exits);
share|improve this answer
    
you mean: N W E S? ;) –  RobAu yesterday
    
now the question is, where is "U" :P –  Zhuinden yesterday
1  
This still requires the same code, just moved into parseExits –  Ross Drew yesterday
    
+1 For enums. Such a powerful tool, and so regularly underused. –  Rudi yesterday
    
Ha ha! 'U' represents 'Up'. Apparently I'm not satisfied with simple compass directions... –  lordchancellor yesterday
show 1 more comment

Given what your code looks like, this is the most readable implementation I could come up with:

public class Exits {
    private static final char[] DIRECTIONS = "NSEWUD".toCharArray();

    public static void main(String... args) {
        String input = "N S E";
        boolean[] exits = new boolean[DIRECTIONS.length];

        for(int i = 0; i< exits.length; i++) {
            if (input.indexOf(DIRECTIONS[i]) >= 0) {
                exits[i] = true;
            }
        }
    }
}

That being said, there's a number of cleaner solutions possible. Personally I would go with enums and an EnumSet.

By the way, your original code is incorrect, as it will set as most one value in the array to true.

share|improve this answer
add comment

All the approaches listed in the answeres are good. But I think the approach you need to take depends on the way you are going to use the exit field. For example if you are going to handle exit as strings then Ross Drews approach would require a lot of if-else conditions and variables.

String exit = "N E";
String[] exits = exit.split(" ");
boolean N = false, E = false, S = false, W = false, U = false, D = false;
for(String e : exits){
    if(e.equalsIgnoreCase("N")){
        N = true;
    } else if(e.equalsIgnoreCase("E")){
        E = true;
    } else if(e.equalsIgnoreCase("W")){
        W= true;
    } else if(e.equalsIgnoreCase("U")){
        U = true;
    } else if(e.equalsIgnoreCase("D")){
        D = true;
    } else if(e.equalsIgnoreCase("S")){
        S = true;
    }
}
setExits(N, E, S, W, U, D);

Also if you have an exit and you want to check whether a location has that particular exit then again you will have to do the same

public boolean hasExit(String exit){
    if(e.equalsIgnoreCase("N")){
        return this.N; // Or the corresponding getter method
    } else if(e.equalsIgnoreCase("E")){
        return this.E;
    } else if(e.equalsIgnoreCase("W")){
        return this.W;
    } else if(e.equalsIgnoreCase("U")){
        return this.U;
    } else if(e.equalsIgnoreCase("D")){
        return this.D;
    } else if(e.equalsIgnoreCase("S")){
        return this.S;
    }
}

So if you are going to manipulate it as a string, in my opinion the best approach would be to go for list and enum. By this way you could do methods like hasExit, hasAnyExit, hasAllExits, hasNorthExit, hasSouthExit, getAvailableExits etc etc.. very easily. And considering the number of exits (6) using a list (or set) wont be an overhead. For example

Enum

public enum EXIT {
        EAST("E"),
        WEST("W"),
        NORTH("N"),
        SOUTH("S"),
        UP("U"),
        DOWN("D");

        private String exitCode;

        private EXIT(String exitCode) {
        this.exitCode = exitCode;
        }

        public String getExitCode() {
        return exitCode;
        }

        public static EXIT fromValue(String exitCode) {
            for (EXIT exit : values()) {
                if (exit.exitCode.equalsIgnoreCase(exitCode)) {
                    return exit;
                }
            }
            return null;
        }

        public static EXIT fromValue(char exitCode) {
            for (EXIT exit : values()) {
                if (exit.exitCode.equalsIgnoreCase(String.valueOf(exitCode))) {
                    return exit;
                }
            }
            return null;
        }
}

Location.java

import java.util.ArrayList;
import java.util.List;


public class Location {

    private List<EXIT> exits;

    public Location(){
        exits = new ArrayList<EXIT>();
    }

    public void setExits(String exits) {
        for(char exitCode :  exits.toCharArray()){
            EXIT exit = EXIT.fromValue(exitCode);
            if(exit != null){
                this.exits.add(exit);
            }
        }
    }

    public boolean hasExit(String exitCode){
        return exits.contains(EXIT.fromValue(exitCode));
    }

    public boolean hasAnyExit(String exits){
        for(char exitCode :  exits.toCharArray()){
            if(this.exits.contains(EXIT.fromValue(exitCode))){
                return true;
            }
        }
        return false;
    }

    public boolean hasAllExit(String exits){
        for(char exitCode :  exits.toCharArray()){
            EXIT exit = EXIT.fromValue(exitCode);
            if(exit != null && !this.exits.contains(exit)){
                return false;
            }
        }
        return true;
    }

    public boolean hasExit(char exitCode){
        return exits.contains(EXIT.fromValue(exitCode));
    }

    public boolean hasNorthExit(){
        return exits.contains(EXIT.NORTH);
    }

    public boolean hasSouthExit(){
        return exits.contains(EXIT.SOUTH);
    }

    public List<EXIT> getExits() {
        return exits;
    }

    public static void main(String args[]) {
        String exits = "N E W";
        Location location = new Location();
        location.setExits(exits);
        System.out.println(location.getExits());
        System.out.println(location.hasExit('W'));
        System.out.println(location.hasAllExit("N W"));
        System.out.println(location.hasAnyExit("U D"));
        System.out.println(location.hasNorthExit());
    }
}
share|improve this answer
    
This seems like a lot of code that achieves not a lot at all. The length could be halved with no loss of usefulness. Also, why List<EXIT>. Why not Set<EXIT>? –  Boann 10 hours ago
    
Yes it can be Set as well. –  Syam S 10 hours ago
add comment

The EnumSet in the other answer is the best way to do this, I just wanted to add one more thing though for the future when you start looking not just at whether you can move but where you are moving to.

As well as EnumSet you also have EnumMap.

If you define a Room class/interface then inside the Room class you can have

Map<Direction, Room> exits = new EnumMap<>(Direction.class);

You can now add your links into the map as follows:

exits.put(Direction.NORTH, theRoomNorthOfMe);

Then your code to move between rooms can be very general purpose:

Room destination=currentRoom.getExit(directionMoved);

if (destination == null) {
    // Cannot move that way
} else {
    // Handle move to destination
}
share|improve this answer
    
This is how I would do it. –  Ultimate Gobblement 12 hours ago
add comment

If you're defining exits as a string, you should use it. I would do it like:

public class LocationWithExits {
    public static final String NORTH_EXIT="[N]";
    public static final String SOUTH_EXIT="[S]";
    public static final String EAST_EXIT="[E]";
    public static final String WEST_EXIT="[W]";

    private final String exitLocations;

    public LocationWithExits(String exitLocations) {
        this.exitLocations = exitLocations;
    }
    public boolean hasNorthExit(){
        return exitLocations.contains(NORTH_EXIT);
    }
    public static void main(String[] args) {
        LocationWithExits testLocation=new LocationWithExits(NORTH_EXIT+SOUTH_EXIT);
        System.out.println("Has exit on north?: "+testLocation.hasNorthExit());
    }


}

using array of booleans might cause a lot of problems if you forget what exactly means bexits[0]. Os it for north or south? etc.

or you can just use enums and list of exits available . Then in methid test if list contain a certain enum value

share|improve this answer
add comment

Personally, I think you can hack it around a bit using an enum and turn the following:

public void setExits(String e) {
    if (e.contains("N"))
        bexits[0] = true;
    else if (e.contains("W"))
        bexits[1] = true;
    else if (e.contains("S"))
        bexits[2] = true;
    else if (e.contains("E"))
        bexits[3] = true;
    else if (e.contains("U"))
        bexits[4] = true;
    else if (e.contains("D"))
        bexits[5] = true;
}

into

public enum Directions
{
    NORTH("N"),
    WEST("W"),
    SOUTH("S"),
    EAST("E"),
    UP("U"),
    DOWN("D");

    private String identifier;

    private Directions(String identifier)
    {
        this.identifier = identifier;
    }

    public String getIdentifier()
    {
        return identifier;
    }
}

and then do:

public void setExits(String e) 
{
  String[] exits = e.split(" ");
  for(String exit : exits)
  {
      for(Directions direction : Directions.values())
      {
          if(direction.getIdentifier().equals(exit))
          {
              bexits[direction.ordinal()] = true;
              break;
          }
      }
  }
}

Although after having written it down, I can't really tell you if it's that much better. It's easier to add new directions, that's for sure.

share|improve this answer
    
I assumed that bexits will be created as boolean bexits = new boolean[Directions.values().length]; –  Zhuinden yesterday
    
To be honest, when I wrote my own code, what I did was use a Map<Directions, Boolean> map = new HashMap<>();, and use them as either map.put(Directions.NORTH, false); or map.get(Directions.NORTH);. It's slightly prettier than the one up above, but it's still not as pretty as the EnumSet by gexicide above. –  Zhuinden yesterday
add comment

If you want a generic solution you can use a map, which maps from a key (in your case W, S, E.. ) to a corresponding value (in your case a boolean).

When you do a set, you update the value the key is associated with. When you do a get, you can take an argument key and simply retrieve the value of the key. This functionality does already exist in map, called put and get.

share|improve this answer
2  
A Map<Object, Boolean> to check for something being set or something existing is logically the same as having a Set<Object> and using the contains method. If the object is in the set, then the corresponding map would have had TRUE, is the object isn't in the set, then the corresponding map would have had FALSE. Not saying your answer is wrong, just another way to think of it that uses a little less space :) –  Dan Temple yesterday
add comment

I really like the idea of assigning the exits from a String, because it makes for brief and readable code. Once that's done, I don't see why you would want to create a boolean array. If you have a String, just use it, although you might want to add some validation to prevent accidental assignment of strings containing unwanted characters:

private String exits;

public void setExits(String e) {
    if (!e.matches("[NSEWUD ]*")) throw new IllegalArgumentException();
    exits = e;
}

The only other thing I would add is a method canExit that you can call with a direction parameter; e.g., if (location.canExit('N')) ...:

public boolean canExit(char direction) {
    return exits.indexOf(direction) >= 0;
}

I like enums, but using them here seems like over-engineering to me, which will rapidly become annoying.


**Edit**: Actually, don't do this. It answers the wrong question, and it does something which doesn't need to be done. I just noticed @TimB's answer of using a map (an EnumMap) to associate directions with rooms. It makes sense.

I still feel that if you only need to track exit existence, a String is simple and effective, and anything else is over-complicating it. However, only knowing which exits are available isn't useful. You will want to go through those exits, and unless your game has a very plain layout it won't be doable for the code to infer the correct room for each direction, so you'll need to explicitly associate each direction with another room. So there seems to be no actual use for any method "setExits" which accepts a list of directions (regardless of how it's implemented internally).

share|improve this answer
add comment
public void setExits(String e)
{
    String directions="NwSEUD";
    for(int i=0;i<directions.length();i++)
    {
        if(e.contains(""+directions.charAt(i)))
        {
            bexits[i]=true;
            break;
        }
    }
}

the iterative way of doing the same thing..

share|improve this answer
add comment

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.